Organization Update
curl --request POST \
--url https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId} \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"description": "This is the customer ID in the core banking system.",
"type": "CUSTOMER",
"metadata": {},
"referenceId": "<string>"
}
]
}
'import requests
url = "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}"
payload = { "externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"description": "This is the customer ID in the core banking system.",
"type": "CUSTOMER",
"metadata": {},
"referenceId": "<string>"
}
] }
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
api_key: '<api-key>',
'X-Frankie-CustomerID': '<x-frankie-customerid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalReferences: [
{
name: 'CUSTOMER-REFERENCE',
value: 'CUST-00001342',
description: 'This is the customer ID in the core banking system.',
type: 'CUSTOMER',
metadata: {},
referenceId: '<string>'
}
]
})
};
fetch('https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalReferences' => [
[
'name' => 'CUSTOMER-REFERENCE',
'value' => 'CUST-00001342',
'description' => 'This is the customer ID in the core banking system.',
'type' => 'CUSTOMER',
'metadata' => [
],
'referenceId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}"
payload := strings.NewReader("{\n \"externalReferences\": [\n {\n \"name\": \"CUSTOMER-REFERENCE\",\n \"value\": \"CUST-00001342\",\n \"description\": \"This is the customer ID in the core banking system.\",\n \"type\": \"CUSTOMER\",\n \"metadata\": {},\n \"referenceId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"externalReferences\": [\n {\n \"name\": \"CUSTOMER-REFERENCE\",\n \"value\": \"CUST-00001342\",\n \"description\": \"This is the customer ID in the core banking system.\",\n \"type\": \"CUSTOMER\",\n \"metadata\": {},\n \"referenceId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalReferences\": [\n {\n \"name\": \"CUSTOMER-REFERENCE\",\n \"value\": \"CUST-00001342\",\n \"description\": \"This is the customer ID in the core banking system.\",\n \"type\": \"CUSTOMER\",\n \"metadata\": {},\n \"referenceId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"organization": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"createdAt": "2023-11-07T05:31:56Z",
"schemaVersion": 2,
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
],
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "leonardo_dc@outlook.com",
"isPreferred": true,
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"customAttributes": {},
"externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
"type": "CUSTOMER",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"description": "This is the customer ID in the core banking system."
}
],
"documents": {
"REPORT": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
],
"SUPPORTING": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
],
"IDENTITY": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
],
"OTHER": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
]
},
"sourceId": "<string>",
"websiteUrls": [
{
"websiteUrl": "<string>",
"sourceId": "<string>"
}
],
"details": {
"type": {
"code": "<string>",
"description": "<string>"
},
"class": {
"code": "<string>",
"description": "<string>"
},
"subClass": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"registrationDetails": [
{
"registrationNumber": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"isCurrent": true,
"registeredName": "<string>",
"registeredNameDetails": {
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
},
"registeredDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"extractedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"registeredSubdivision": "<string>",
"registeredCountry": "<string>",
"registrationStatus": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"registrationNumberType": "<string>",
"registrationNumberDescription": "<string>",
"updatedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"reviewDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"foundationDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"isSuppressed": true,
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"alternateNames": [
{
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
}
],
"name": {
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
},
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"jurisdiction": {
"country": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
},
"industryDeclarations": [
{
"code": "<string>",
"description": "<string>",
"language": "<string>"
}
],
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
]
},
"shareholders": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"shareholderType": "<string>",
"totalShares": 123,
"totalPercentage": 123,
"shareholdings": [
{
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": 123,
"amountDue": 123,
"amount": 123,
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"percentage": 123,
"isNonBeneficiallyHeld": true,
"isJointlyHeld": true
}
]
}
],
"shareInterests": [
{
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": 123,
"amountDue": 123,
"amount": 123,
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"percentage": 123,
"isBeneficiallyHeld": true,
"isJointlyHeld": true,
"members": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL"
}
]
}
],
"officials": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"role": {
"code": "<string>",
"description": "<string>"
},
"identification": [
{
"type": "DIRECTOR_IDENTIFICATION_NUMBER",
"idNumber": "<string>",
"jurisdiction": {
"country": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
}
],
"sourceId": "<string>",
"appointmentDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"cessationDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"directorships": [
{
"organization": {
"organizationName": "<string>",
"registrationNumber": "<string>",
"organizationStatus": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
}
},
"role": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>",
"appointmentDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"nationality": "<string>"
}
]
}
],
"shareCapital": {
"totalShareCount": 123,
"shareStructure": [
{
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": 123,
"amountDue": 123,
"amount": 123,
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
}
}
]
},
"indicators": [
{
"flag": "<string>",
"value": 123
}
],
"jurisdictionalInformation": {
"personsOfSignificantControl": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"kind": "<string>",
"natureOfControl": [
"<string>"
],
"notifiedOn": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"ceasedOn": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"countryOfResidence": "<string>"
}
],
"registryInformation": {
"abnReplacedFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"charityInformation": [
{
"type": "<string>",
"name": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"gst": [
{
"type": "<string>",
"name": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"superannuationStatus": {
"complyingCode": "<string>",
"complyingDescription": "<string>",
"regulator": "<string>",
"exceptionMessage": "<string>"
},
"acncRegistrations": [
{
"status": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"dgr": [
{
"dgrEntityEndorsement": "<string>",
"dgrItemNumber": "<string>"
}
],
"disclosingEntity": true
},
"aliases": [
"<string>"
],
"agents": [
{
"name": "<string>",
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
]
}
],
"vatNumber": "<string>",
"virtualId": "<string>",
"officers": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"title": "<string>",
"assignedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"type": "<string>"
}
],
"fiscalCode": {
"code": "<string>",
"description": "<string>"
},
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"annualAccount": {
"lastAnnualAccountDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
},
"creditIndicators": {
"courtActionsCount": 123,
"enquiriesCount": 123,
"mercantileEnquiriesCount": 123,
"directorsCount": 123,
"directorsCourtActionsCount": 123,
"directorFailedBusinessCount": 123,
"tradeReferencesCount": 123,
"sourceId": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"linkedIndividuals": {},
"linkedOrganizations": {},
"linkedUnknownEntities": {},
"blockingEntities": {},
"ultimateBeneficialOwners": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"percentageOwned": {
"total": 123,
"isTotalNearZero": true,
"beneficially": 123,
"isBeneficialNearZero": true,
"nonBeneficially": 123,
"isNonBeneficialNearZero": true,
"isContainingJointOwnership": true
},
"reasons": [
{
"code": "<string>",
"description": "<string>"
}
],
"sourceId": "<string>"
}
],
"otherOwners": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"percentageOwned": {
"total": 123,
"isTotalNearZero": true,
"beneficially": 123,
"isBeneficialNearZero": true,
"nonBeneficially": 123,
"isNonBeneficialNearZero": true,
"isContainingJointOwnership": true
},
"sourceId": "<string>"
}
],
"informationSources": {},
"ownershipPolicy": {
"uboThreshold": 123,
"blockingThreshold": 123,
"blockingDefinitions": [
"ORGANISATION_NOT_FOUND"
]
}
}
}{
"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"
}Organizations
Organization Update
Update metadata associated with an organization. Note: It is not possible to override data that has been fetched from an authoritative source. If data on an organization is found to be incorrect, this needs to be fixed in consultation with the official registry before refetching, or locally accepted as a risk. This endpoint only allows modifying metadata associated with the entity.
POST
/
v2
/
organizations
/
{entityId}
Organization Update
curl --request POST \
--url https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId} \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"description": "This is the customer ID in the core banking system.",
"type": "CUSTOMER",
"metadata": {},
"referenceId": "<string>"
}
]
}
'import requests
url = "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}"
payload = { "externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"description": "This is the customer ID in the core banking system.",
"type": "CUSTOMER",
"metadata": {},
"referenceId": "<string>"
}
] }
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
api_key: '<api-key>',
'X-Frankie-CustomerID': '<x-frankie-customerid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
externalReferences: [
{
name: 'CUSTOMER-REFERENCE',
value: 'CUST-00001342',
description: 'This is the customer ID in the core banking system.',
type: 'CUSTOMER',
metadata: {},
referenceId: '<string>'
}
]
})
};
fetch('https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalReferences' => [
[
'name' => 'CUSTOMER-REFERENCE',
'value' => 'CUST-00001342',
'description' => 'This is the customer ID in the core banking system.',
'type' => 'CUSTOMER',
'metadata' => [
],
'referenceId' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}"
payload := strings.NewReader("{\n \"externalReferences\": [\n {\n \"name\": \"CUSTOMER-REFERENCE\",\n \"value\": \"CUST-00001342\",\n \"description\": \"This is the customer ID in the core banking system.\",\n \"type\": \"CUSTOMER\",\n \"metadata\": {},\n \"referenceId\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"externalReferences\": [\n {\n \"name\": \"CUSTOMER-REFERENCE\",\n \"value\": \"CUST-00001342\",\n \"description\": \"This is the customer ID in the core banking system.\",\n \"type\": \"CUSTOMER\",\n \"metadata\": {},\n \"referenceId\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kycaml.frankiefinancial.io/v2/organizations/{entityId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalReferences\": [\n {\n \"name\": \"CUSTOMER-REFERENCE\",\n \"value\": \"CUST-00001342\",\n \"description\": \"This is the customer ID in the core banking system.\",\n \"type\": \"CUSTOMER\",\n \"metadata\": {},\n \"referenceId\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"organization": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"createdAt": "2023-11-07T05:31:56Z",
"schemaVersion": 2,
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
],
"unstructuredLongForm": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "leonardo_dc@outlook.com",
"isPreferred": true,
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
],
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"customAttributes": {},
"externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
"type": "CUSTOMER",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
"metadata": {},
"updatedAt": "2023-11-07T05:31:56Z",
"description": "This is the customer ID in the core banking system."
}
],
"documents": {
"REPORT": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
],
"SUPPORTING": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
],
"IDENTITY": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
],
"OTHER": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"isDigital": true,
"isExternallyVerified": true,
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"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"
}
]
}
]
},
"sourceId": "<string>",
"websiteUrls": [
{
"websiteUrl": "<string>",
"sourceId": "<string>"
}
],
"details": {
"type": {
"code": "<string>",
"description": "<string>"
},
"class": {
"code": "<string>",
"description": "<string>"
},
"subClass": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"registrationDetails": [
{
"registrationNumber": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"isCurrent": true,
"registeredName": "<string>",
"registeredNameDetails": {
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
},
"registeredDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"extractedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"registeredSubdivision": "<string>",
"registeredCountry": "<string>",
"registrationStatus": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"registrationNumberType": "<string>",
"registrationNumberDescription": "<string>",
"updatedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"reviewDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"foundationDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"isSuppressed": true,
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"alternateNames": [
{
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
}
],
"name": {
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
},
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"jurisdiction": {
"country": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
},
"industryDeclarations": [
{
"code": "<string>",
"description": "<string>",
"language": "<string>"
}
],
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
]
},
"shareholders": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"shareholderType": "<string>",
"totalShares": 123,
"totalPercentage": 123,
"shareholdings": [
{
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": 123,
"amountDue": 123,
"amount": 123,
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"percentage": 123,
"isNonBeneficiallyHeld": true,
"isJointlyHeld": true
}
]
}
],
"shareInterests": [
{
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": 123,
"amountDue": 123,
"amount": 123,
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"percentage": 123,
"isBeneficiallyHeld": true,
"isJointlyHeld": true,
"members": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL"
}
]
}
],
"officials": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"role": {
"code": "<string>",
"description": "<string>"
},
"identification": [
{
"type": "DIRECTOR_IDENTIFICATION_NUMBER",
"idNumber": "<string>",
"jurisdiction": {
"country": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
}
],
"sourceId": "<string>",
"appointmentDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"cessationDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
},
"directorships": [
{
"organization": {
"organizationName": "<string>",
"registrationNumber": "<string>",
"organizationStatus": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
}
},
"role": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>",
"appointmentDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"nationality": "<string>"
}
]
}
],
"shareCapital": {
"totalShareCount": 123,
"shareStructure": [
{
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": 123,
"amountDue": 123,
"amount": 123,
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
}
}
}
]
},
"indicators": [
{
"flag": "<string>",
"value": 123
}
],
"jurisdictionalInformation": {
"personsOfSignificantControl": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"kind": "<string>",
"natureOfControl": [
"<string>"
],
"notifiedOn": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"ceasedOn": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"countryOfResidence": "<string>"
}
],
"registryInformation": {
"abnReplacedFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"charityInformation": [
{
"type": "<string>",
"name": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"gst": [
{
"type": "<string>",
"name": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"superannuationStatus": {
"complyingCode": "<string>",
"complyingDescription": "<string>",
"regulator": "<string>",
"exceptionMessage": "<string>"
},
"acncRegistrations": [
{
"status": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"dgr": [
{
"dgrEntityEndorsement": "<string>",
"dgrItemNumber": "<string>"
}
],
"disclosingEntity": true
},
"aliases": [
"<string>"
],
"agents": [
{
"name": "<string>",
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
]
}
],
"vatNumber": "<string>",
"virtualId": "<string>",
"officers": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"title": "<string>",
"assignedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"type": "<string>"
}
],
"fiscalCode": {
"code": "<string>",
"description": "<string>"
},
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"annualAccount": {
"lastAnnualAccountDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
},
"creditIndicators": {
"courtActionsCount": 123,
"enquiriesCount": 123,
"mercantileEnquiriesCount": 123,
"directorsCount": 123,
"directorsCourtActionsCount": 123,
"directorFailedBusinessCount": 123,
"tradeReferencesCount": 123,
"sourceId": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"linkedIndividuals": {},
"linkedOrganizations": {},
"linkedUnknownEntities": {},
"blockingEntities": {},
"ultimateBeneficialOwners": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"percentageOwned": {
"total": 123,
"isTotalNearZero": true,
"beneficially": 123,
"isBeneficialNearZero": true,
"nonBeneficially": 123,
"isNonBeneficialNearZero": true,
"isContainingJointOwnership": true
},
"reasons": [
{
"code": "<string>",
"description": "<string>"
}
],
"sourceId": "<string>"
}
],
"otherOwners": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"percentageOwned": {
"total": 123,
"isTotalNearZero": true,
"beneficially": 123,
"isBeneficialNearZero": true,
"nonBeneficially": 123,
"isNonBeneficialNearZero": true,
"isContainingJointOwnership": true
},
"sourceId": "<string>"
}
],
"informationSources": {},
"ownershipPolicy": {
"uboThreshold": 123,
"blockingThreshold": 123,
"blockingDefinitions": [
"ORGANISATION_NOT_FOUND"
]
}
}
}{
"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
Headers
Your API key provided by FrankieOne
Example:
"245c765b124a098d09ef8765...."
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.
Path Parameters
Unique FrankieOne identifier for an entity
Body
application/json
Show child attributes
Show child attributes
Was this page helpful?