Document Analyses Results
curl --request GET \
--url https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses \
--header 'Authorization: Bearer <token>' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api_key>'import requests
url = "https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses"
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"api_key": "<api_key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Frankie-CustomerID': '<x-frankie-customerid>',
api_key: '<api_key>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses', 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/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("api_key", "<api_key>")
req.Header.Add("Authorization", "Bearer <token>")
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/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("api_key", "<api_key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["api_key"] = '<api_key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"analyses": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"status": "PROCESSING",
"analysisId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"references": {},
"documentInformation": {
"type": "TRUST_DOCUMENT",
"trust": {
"name": {
"value": "<string>",
"referenceIds": [
"<string>"
]
},
"establishment": {
"date": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31",
"referenceIds": [
"<string>"
]
},
"country": {
"value": "<string>",
"referenceIds": [
"<string>"
]
},
"subdivision": {
"value": "<string>",
"referenceIds": [
"<string>"
]
}
},
"certification": {
"date": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31",
"referenceIds": [
"<string>"
]
}
},
"execution": {
"date": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31",
"referenceIds": [
"<string>"
]
}
},
"linkedIndividuals": {},
"linkedOrganizations": {},
"linkedUnknownEntities": {},
"settlors": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"trustees": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"type": {
"provided": "DISCRETIONARY",
"detected": "DISCRETIONARY"
},
"typeInformation": {
"type": "DISCRETIONARY",
"discretionary": {
"specifiedBeneficiaries": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"generalBeneficiaries": [
{
"value": "<string>",
"referenceIds": [
"<string>"
]
}
],
"appointors": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"protectors": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
]
}
}
}
},
"errors": [
{
"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"
}{
"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"
}Organization
Document Analyses Results
Get Document Analyses Results
GET
/
v2
/
organizations
/
{entityId}
/
documents
/
{documentId}
/
analyses
Document Analyses Results
curl --request GET \
--url https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses \
--header 'Authorization: Bearer <token>' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api_key>'import requests
url = "https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses"
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"api_key": "<api_key>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Frankie-CustomerID': '<x-frankie-customerid>',
api_key: '<api_key>',
Authorization: 'Bearer <token>'
}
};
fetch('https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses', 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/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("api_key", "<api_key>")
req.Header.Add("Authorization", "Bearer <token>")
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/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("api_key", "<api_key>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/experimental/v2/organizations/{entityId}/documents/{documentId}/analyses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["api_key"] = '<api_key>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"analyses": [
{
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"status": "PROCESSING",
"analysisId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"references": {},
"documentInformation": {
"type": "TRUST_DOCUMENT",
"trust": {
"name": {
"value": "<string>",
"referenceIds": [
"<string>"
]
},
"establishment": {
"date": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31",
"referenceIds": [
"<string>"
]
},
"country": {
"value": "<string>",
"referenceIds": [
"<string>"
]
},
"subdivision": {
"value": "<string>",
"referenceIds": [
"<string>"
]
}
},
"certification": {
"date": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31",
"referenceIds": [
"<string>"
]
}
},
"execution": {
"date": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31",
"referenceIds": [
"<string>"
]
}
},
"linkedIndividuals": {},
"linkedOrganizations": {},
"linkedUnknownEntities": {},
"settlors": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"trustees": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"type": {
"provided": "DISCRETIONARY",
"detected": "DISCRETIONARY"
},
"typeInformation": {
"type": "DISCRETIONARY",
"discretionary": {
"specifiedBeneficiaries": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"generalBeneficiaries": [
{
"value": "<string>",
"referenceIds": [
"<string>"
]
}
],
"appointors": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
],
"protectors": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"referenceIds": [
"<string>"
]
}
]
}
}
}
},
"errors": [
{
"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"
}{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Your Customer ID provided by FrankieOne
Example:
"12345678-1234-1234-1234-123456789012"
Your Customer Child ID provided by FrankieOne
Example:
"87654321-4321-4321-4321-210987654321"
Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.
Your API key provided by FrankieOne
Example:
"245c765b124a098d09ef8765...."
Path Parameters
Unique identifier for a document
Unique FrankieOne identifier for an entity
Query Parameters
Which types of results should be shown The different options for what results should be returned.
- COMPLETE: Only completed results will be shown.
- CONFIRMED: Only confirmed results will be shown.
- LATEST: Only the latest results will be shown (confirmed or completed).
Available options:
COMPLETE, CONFIRMED, LATEST Response
OK
Entities are assigned a FrankieOne auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.
Example:
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Show child attributes
Show child attributes
The unique request identifier for the API call made.
Example:
"01HN9XHZN6MGXM9JXG50K59Q85"
Was this page helpful?