GET/v3/live/person/asynchronous/deep-match/{id}

Get a Deep Match batch

Returns the status of a Deep Match batch and, once it is READY, one result per submitted row in submission order, each with the criteria that resolved it.

Version
v3
Rate limit
Tier 4 · 10–500 rps by plan
Billing
DEEP_MATCH · Get a Deep Match batch

Path parameters

  • idstringRequired
    Batch UUID
Headers
x-api-key Required · API key for authentication

Response

  • batchIdstring
    Batch identifier.
  • itemsobject[]
    One entry per submitted row, in submission order.
  • rowCountinteger (int32)
    Rows submitted. Credits are charged per row that resolves to a subject, so this is an upper bound on what the batch costs.
  • statusenum DeepMatchBatchStatus
    Batch status. Poll again while PENDING.

Status codes