Skip to main content
GET
/
v2
/
organizations
/
{entityId}
/
documents
/
{documentId}
/
attachments
/
{attachmentId}
Get Attachment
curl --request GET \
  --url https://api.frankie.one/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
  "requestId": "<string>",
  "attachment": {
    "data": {
      "uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
    },
    "attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sourceId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "filename": "<string>",
    "mimeType": "<string>",
    "pageNumber": 123,
    "side": "FRONT",
    "type": "<string>",
    "location": "<string>",
    "lastMalwareScanAt": "2023-11-07T05:31:56Z",
    "retrievalStatus": "NORMAL"
  },
  "informationSource": {
    "sourceId": "<string>",
    "type": "ID number",
    "source": "Client",
    "description": "",
    "provider": "equifax-au",
    "providerReference": "",
    "createdAt": "2024-01-15T02:18:11.365Z",
    "requestedAt": "2024-01-15T02:18:11.365Z",
    "generatedAt": "2024-01-15T02:18:11.365Z",
    "retrievedAt": "2024-01-15T02:18:11.365Z",
    "updatedAt": "2024-01-15T02:18:11.365Z",
    "isAuthoritative": false,
    "isManual": true
  }
}

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