Skip to main content

Export identity correlation decisions​

Returns every decided identity correlation — accepted or rejected by a reviewer, linked or rejected by the matcher, or superseded — newest decision first, with the evidence it was decided on (confidence, similarity, compared attributes, reasoning) and who decided it. For eDiscovery and audit exports: page through with the cursor.

A decision reflects the pair's current state: a matcher rejection that a settings change re-queues leaves this export until it is decided again. Link and unlink history, including changes made outside the review queue, is in /ip/nhi/identity-change-audit.

Query Parameters
  • limit integer

    Possible values: >= 1 and <= 100

    The maximum number of items to return. Maximum value is 100.

  • cursor string

    Opaque pagination token returned by a previous request (next_cursor, prev_cursor or last_cursor). Omit it to fetch the first page.

  • decided_from date-time

    Only decisions taken at or after this time

  • decided_to date-time

    Only decisions taken before this time

  • decided_by string

    Possible values: [any, person, system]

    Default value: any

    Only decisions taken by a person, or only those the matcher took

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

One page of decided correlations

Schema
  • result object[]
  • id string
  • identity_id string
  • candidate_identity_id string
  • candidate_canonical_identity_id string

    The candidate's canonical identity when it was scored

  • matcher string

    Possible values: [ai, similarity]

  • confidence double

    The AI matcher's confidence (absent for similarity proposals)

  • similarity_score double
  • matched_attributes object[]
  • field string
  • identity_value string
  • candidate_field string
  • candidate_value string
  • similarity double
  • reasoning string
  • model string
  • scored_at date-time
  • status string

    Possible values: [pending, accepted, rejected, auto_linked, superseded]

    pending: waiting for review. accepted / rejected: decided by a person, or rejected by the matcher (decided_by "system") when below the review threshold. auto_linked: linked by the matcher. superseded: withdrawn because the identity was linked another way, left, or its compared attributes changed.

  • decided_by string

    The person who decided, or "system" for the matcher

  • decided_at date-time
  • decision_note string
  • identity object
  • id string
  • name string
  • identifier string
  • identity_type string
  • source_type string
  • connection_id string
  • connection_name string
  • canonical_identity_id string
  • imported_at date-time

    When the account was first seen

  • candidate_identity object
  • id string
  • name string
  • identifier string
  • identity_type string
  • source_type string
  • connection_id string
  • connection_name string
  • canonical_identity_id string
  • imported_at date-time

    When the account was first seen

  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.