Regbase API
Reference

Download a document rendition

Returns the raw bytes for a rendition using its Public Rendition ID. `Content-Type` matches the rendition's `mime` attribute (for example `application/pdf`, `text/html`, or `text/plain`).

GET
/v1/entities/{id}/renditions/{renditionId}.{extension}

Returns the raw bytes for a rendition using its Public Rendition ID. Content-Type matches the rendition's mime attribute (for example application/pdf, text/html, or text/plain).

Authorization

bearerAuth
AuthorizationBearer <token>

Organization API key. Send Authorization: Bearer rb_live_….

In: header

Path Parameters

id*string

Entity id ([0-9a-z]+).

Match^[0-9a-z]+$
renditionId*string

Public Rendition ID (rnd_ followed by 32 hex characters).

Match^rnd_[0-9a-f]{32}$
extension*string

File extension from the rendition content link, identifying its media type.

Match^[a-z0-9]+$

Response Body

*/*

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

curl -X GET "https://example.com/v1/entities/string/renditions/string.string"
"string"

Get an entity by id GET

Previous Page

List entities GET

Returns canonical entities (not drained or merged, not empty snapshots) ordered by id. Optional GFFS qualifier string. Omit to list all entities. Free-text terms are rejected. Allowed fields: type, title, name, displayDate, jurisdiction, localIdentifier, localType, authority, status.