Get scan file

GET

/v1/scans/:id/file

Return a short-lived signed URL to download the scanned document; fetch it promptly

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_… in production or usgmk_test_… in the sandbox.

idstringRequiredformat: "uuid"

urlstringformat: "uri"

Short-lived signed download URL — fetch promptly, do not store it.

expires_atdatetime

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

$	curl https://api.usglobalmail.com/v1/scans/id/file \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"

1	{
2	"url": "https://usglobalmail.s3.amazonaws.com/scans/3f2504e0-4f89-11d3-9a0c-0305e82c3301.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T123000Z&X-Amz-Expires=300&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
3	"expires_at": "2024-01-15T09:30:00Z"
4	}