Get Attachment

Path parameters

entityIdstringRequired
Unique FrankieOne identifier for an entity
documentIdstringRequired
Unique identifier for a document
attachmentIdstringRequired

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne

Query parameters

formatenumOptional

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

Allowed values:

Response

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

requestIdstring or null
attachmentobject or null
Document attachment details.
informationSourceobject or null

Errors