Skip to main content
GET
Get Attachment

Authorizations

api_key
string
header
required

Headers

api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

Path Parameters

entityId
string
required

Unique FrankieOne identifier for an entity

documentId
string
required

Unique identifier for a document

attachmentId
string
required

Query Parameters

format
enum<string>

Enum of the attachment format - [NONE, BASE64, RAW]

Available options:
NONE,
BASE64,
RAW

Response

OK - depending on request attachment format the type of content is returned, if raw is requested different file types are expected

requestId
string
attachment
object

Document attachment details.

informationSource
object
read-only