Skip to main content
GET
/
v2
/
organizations
/
{entityId}
/
documents
/
{documentId}
/
attachments
/
{attachmentId}
Get Attachment
curl --request GET \
  --url https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
import requests

url = "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}"

headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {api_key: '<api-key>', 'X-Frankie-CustomerID': '<x-frankie-customerid>'}
};

fetch('https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Frankie-CustomerID: <x-frankie-customerid>",
"api_key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}/documents/{documentId}/attachments/{attachmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'

response = http.request(request)
puts response.read_body
{
  "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,
    "type": "<string>",
    "location": "<string>",
    "lastMalwareScanAt": "2023-11-07T05:31:56Z"
  },
  "informationSource": {
    "sourceId": "<string>",
    "source": "Client",
    "sourceNormalized": "<string>",
    "description": "",
    "provider": "equifax-au",
    "providerReference": "",
    "createdAt": "2024-01-15T02:18:11.365Z",
    "requestedAt": "2024-01-15T02:18:11.365Z",
    "retrievedAt": "2024-01-15T02:18:11.365Z",
    "isAuthoritative": false
  }
}
{
"errorCode": "<string>",
"errorMsg": "<string>",
"details": [
{
"issue": "<string>",
"issueLocation": "<string>",
"issueType": "<string>"
}
],
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
"errorCode": "<string>",
"errorMsg": "<string>",
"details": [
{
"issue": "<string>",
"issueLocation": "<string>",
"issueType": "<string>"
}
],
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
"errorCode": "<string>",
"errorMsg": "<string>",
"details": [
{
"issue": "<string>",
"issueLocation": "<string>",
"issueType": "<string>"
}
],
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
"errorCode": "<string>",
"errorMsg": "<string>",
"details": [
{
"issue": "<string>",
"issueLocation": "<string>",
"issueType": "<string>"
}
],
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}
{
"errorCode": "<string>",
"errorMsg": "<string>",
"details": [
{
"issue": "<string>",
"issueLocation": "<string>",
"issueType": "<string>"
}
],
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

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