E-File Magic

Recipients

Find duplicate recipients

Find possible duplicate recipients within a filer.

GET
/api/v1/recipients/dedupe/groups
Authentication
OAuth 2.0 access token
Required scopes
recipients.read
Idempotency key
Not required
Rate-limit cost
3 units

On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.

Response fields

3 fields
itemsAlways returnedarray<object>

Maximum items: 100.

Nested fields (5)

form_idAlways returnedstring

Type: string.

recipient_countAlways returnedinteger

Minimum: 2.

recipient_idsAlways returnedarray<string (uuid)>

Type: array<string (uuid)>.

recipient_ids_truncatedAlways returnedboolean

Type: boolean.

tinAlways returnedstring

Always masked.

next_cursorMay be omittedstring | null

Maximum characters: 4096.

total_countMay be omittedinteger | null

Minimum: 0.

Complete response schema: ApiV1RecipientDedupeGroupsResponse

Example · HTTP 200
{
  "data": {
    "items": [],
    "next_cursor": null,
    "total_count": null
  },
  "meta": {
    "api_version": "v1",
    "request_id": "example-request-id"
  }
}

No matching records. Synthetic empty-page example. Follow a non-null next_cursor even when items is empty. A null total_count means no count was supplied.