W-9 requests
Find W-9 recipient matches
Read potential recipient matches for completed W-9 requests.
/api/v1/w9/recipient_matches/get_many- Authentication
- OAuth 2.0 access token
- Required scopes
w9.read- Idempotency key
- Not required
- Rate-limit cost
- 2 units
How to use this endpoint
Provide authorized request IDs. Review the matches before converting a request into a recipient. Missing request records cause the request to fail.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/w9/recipient_matches/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"request_ids":["11111111-1111-4111-8111-111111111111"]}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
1 fieldsrequest_idsRequiredarray<string (uuid)>
IDs of the W-9 requests to process. Minimum items: 1. Maximum items: 100. Items must be unique.
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.
Complete request schema: ApiV1W9RecipientMatchesGetManyRequest
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/w9/recipient_matches/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"request_ids":["11111111-1111-4111-8111-111111111111"]}'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
2 fieldsitemsAlways returnedarray<object>
Maximum items: 100.
Nested fields (3)
itemsAlways returnedarray<object>
Type: array<object>.
request_idAlways returnedstring (uuid)
Type: string (uuid).
truncatedAlways returnedboolean
Type: boolean.
missingAlways returnedarray<string (uuid)>
Maximum items: 100.
Complete response schema: ApiV1W9RecipientMatchesGetManyResponse
{
"data": {
"items": "array<object>",
"missing": "array<string (uuid)>"
},
"meta": {
"api_version": "v1",
"request_id": "string"
}
}Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.
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.