Saved filing reviews
Get a saved filing review
Retrieve an existing review link and its expiration.
/api/v1/filing-reviews/get- Authentication
- OAuth 2.0 access token
- Required scopes
orders.read- Idempotency key
- Not required
- Rate-limit cost
- 1 unit
How to use this endpoint
Use the same delegated agent authority that prepared the review. If authorization or the saved selection has changed or expired, prepare a new review. Reading a review does not submit or charge.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/filing-reviews/get' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"review_id":"11111111-1111-4111-8111-111111111111"}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
1 fieldsreview_idRequiredstring (uuid)
Review identifier returned by filing-reviews/prepare.
Headers (1)
AuthorizationRequired- OAuth Bearer token with the listed scopes and current resource authorization.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/filing-reviews/get' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"review_id":"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
4 fieldsexpires_atAlways returnedinteger
Unix seconds.
order_idAlways returnedstring (uuid)
Type: string (uuid).
review_idAlways returnedstring (uuid)
Type: string (uuid).
review_urlAlways returnedstring (uri)
Open in the browser for the originating user's review and explicit checkout.
{
"data": {
"expires_at": "integer",
"order_id": "string (uuid)",
"review_id": "string (uuid)",
"review_url": "string (uri)"
},
"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.