Recipients
Find duplicate recipients
Find possible duplicate recipients within a filer.
/api/v1/recipients/dedupe/groups- Authentication
- OAuth 2.0 access token
- Required scopes
recipients.read- Idempotency key
- Not required
- Rate-limit cost
- 3 units
How to use this endpoint
The results are candidates for review, not an instruction to merge automatically. Tax ID evidence is masked.
curl --request GET 'https://api.efilemagic.com/api/v1/recipients/dedupe/groups' \
--header 'Authorization: Bearer <access-token>' \
--get \
--data-urlencode 'filer_id=<filer_id>' \
--data-urlencode 'limit=25'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
3 fieldsquery.filer_idRequiredstring (uuid)
ID of the filer that owns this operation's records.
query.limitOptionalinteger
Maximum number of results requested for this page. Minimum: 1. Maximum: 100.
query.cursorOptionalstring
Opaque next_cursor from the previous page. Keep the other filters unchanged. Minimum characters: 1. Maximum characters: 2048.
Headers (2)
AuthorizationRequired- OAuth RS256 access token issued for the EFM API resource. Interactive EFM session tokens are rejected.
DPoPConditional / optional- Required when the application, connection, or credential is proof-of-possession bound.
curl --request GET 'https://api.efilemagic.com/api/v1/recipients/dedupe/groups' \
--header 'Authorization: Bearer <access-token>' \
--get \
--data-urlencode 'filer_id=<filer_id>' \
--data-urlencode 'limit=25'Replace placeholders with your own values. Use the API resource origin provided for your environment.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
3 fieldsitemsAlways 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
{
"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.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.