Skip to main content
GET
Get Document URL
Issues a fresh signed download link for one document attached to a payer name. Documents are stored privately. The downloadUrl returned inside a payer name expires 1 hour after that response was generated, so a link you cached earlier will stop working — call this endpoint when you need a live one.

Example Request

Example Response

The link is valid for 1 hour and grants access to whoever holds it — treat it like a credential and do not put it somewhere public.
documentId must be a document on that payer name, and the payer name must belong to your account. Anything else answers 404.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Path Parameters

payerNameId
string<uuid>
required

The payer name id.

documentId
string<uuid>
required

The document id, as returned in documents[].id.

Response

Document URL generated

status
integer

HTTP status code, repeated in the body

Example:

200

message
string
Example:

"Document URL generated"

success
boolean
Example:

true

data
object