Provide hosted url for a hosted version of onesdk.
curl --request POST \
--url https://api.uat.frankie.one/v2/individuals/hostedurl \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"applicationRef": "<string>",
"channelRef": "<string>",
"consent": true,
"customerRef": "<string>",
"entityId": "<string>",
"errorRedirectURL": "<string>",
"pendingRedirectURL": "<string>",
"oneSDKFlowId": "<string>",
"phoneCode": "<string>",
"phoneNumber": "+6140000000",
"recipientName": "<string>",
"sendSMS": true,
"successRedirectURL": "<string>",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"requestedDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"optionalDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"partialDocuments": [
{
"title": "<string>",
"minimumRequirement": 123,
"documents": [
{
"documentType": "<string>",
"subType": "<string>"
}
]
}
]
}
'import requests
url = "https://api.uat.frankie.one/v2/individuals/hostedurl"
payload = {
"applicationRef": "<string>",
"channelRef": "<string>",
"consent": True,
"customerRef": "<string>",
"entityId": "<string>",
"errorRedirectURL": "<string>",
"pendingRedirectURL": "<string>",
"oneSDKFlowId": "<string>",
"phoneCode": "<string>",
"phoneNumber": "+6140000000",
"recipientName": "<string>",
"sendSMS": True,
"successRedirectURL": "<string>",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"requestedDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"optionalDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"partialDocuments": [
{
"title": "<string>",
"minimumRequirement": 123,
"documents": [
{
"documentType": "<string>",
"subType": "<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({
applicationRef: '<string>',
channelRef: '<string>',
consent: true,
customerRef: '<string>',
entityId: '<string>',
errorRedirectURL: '<string>',
pendingRedirectURL: '<string>',
oneSDKFlowId: '<string>',
phoneCode: '<string>',
phoneNumber: '+6140000000',
recipientName: '<string>',
sendSMS: true,
successRedirectURL: '<string>',
comment: {
text: 'Update after speaking to customer over the phone directly.',
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
},
requestedDocuments: [{documentType: '<string>', subType: '<string>'}],
optionalDocuments: [{documentType: '<string>', subType: '<string>'}],
partialDocuments: [
{
title: '<string>',
minimumRequirement: 123,
documents: [{documentType: '<string>', subType: '<string>'}]
}
]
})
};
fetch('https://api.uat.frankie.one/v2/individuals/hostedurl', 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.uat.frankie.one/v2/individuals/hostedurl",
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([
'applicationRef' => '<string>',
'channelRef' => '<string>',
'consent' => true,
'customerRef' => '<string>',
'entityId' => '<string>',
'errorRedirectURL' => '<string>',
'pendingRedirectURL' => '<string>',
'oneSDKFlowId' => '<string>',
'phoneCode' => '<string>',
'phoneNumber' => '+6140000000',
'recipientName' => '<string>',
'sendSMS' => true,
'successRedirectURL' => '<string>',
'comment' => [
'text' => 'Update after speaking to customer over the phone directly.',
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
],
'requestedDocuments' => [
[
'documentType' => '<string>',
'subType' => '<string>'
]
],
'optionalDocuments' => [
[
'documentType' => '<string>',
'subType' => '<string>'
]
],
'partialDocuments' => [
[
'title' => '<string>',
'minimumRequirement' => 123,
'documents' => [
[
'documentType' => '<string>',
'subType' => '<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.uat.frankie.one/v2/individuals/hostedurl"
payload := strings.NewReader("{\n \"applicationRef\": \"<string>\",\n \"channelRef\": \"<string>\",\n \"consent\": true,\n \"customerRef\": \"<string>\",\n \"entityId\": \"<string>\",\n \"errorRedirectURL\": \"<string>\",\n \"pendingRedirectURL\": \"<string>\",\n \"oneSDKFlowId\": \"<string>\",\n \"phoneCode\": \"<string>\",\n \"phoneNumber\": \"+6140000000\",\n \"recipientName\": \"<string>\",\n \"sendSMS\": true,\n \"successRedirectURL\": \"<string>\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"requestedDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"optionalDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"partialDocuments\": [\n {\n \"title\": \"<string>\",\n \"minimumRequirement\": 123,\n \"documents\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ]\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.uat.frankie.one/v2/individuals/hostedurl")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"applicationRef\": \"<string>\",\n \"channelRef\": \"<string>\",\n \"consent\": true,\n \"customerRef\": \"<string>\",\n \"entityId\": \"<string>\",\n \"errorRedirectURL\": \"<string>\",\n \"pendingRedirectURL\": \"<string>\",\n \"oneSDKFlowId\": \"<string>\",\n \"phoneCode\": \"<string>\",\n \"phoneNumber\": \"+6140000000\",\n \"recipientName\": \"<string>\",\n \"sendSMS\": true,\n \"successRedirectURL\": \"<string>\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"requestedDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"optionalDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"partialDocuments\": [\n {\n \"title\": \"<string>\",\n \"minimumRequirement\": 123,\n \"documents\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/individuals/hostedurl")
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 \"applicationRef\": \"<string>\",\n \"channelRef\": \"<string>\",\n \"consent\": true,\n \"customerRef\": \"<string>\",\n \"entityId\": \"<string>\",\n \"errorRedirectURL\": \"<string>\",\n \"pendingRedirectURL\": \"<string>\",\n \"oneSDKFlowId\": \"<string>\",\n \"phoneCode\": \"<string>\",\n \"phoneNumber\": \"+6140000000\",\n \"recipientName\": \"<string>\",\n \"sendSMS\": true,\n \"successRedirectURL\": \"<string>\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"requestedDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"optionalDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"partialDocuments\": [\n {\n \"title\": \"<string>\",\n \"minimumRequirement\": 123,\n \"documents\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"url": "<string>",
"urlExpiry": "2020-01-01T00:00:00.000Z",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}HostedURL
Provide hosted url for a hosted version of onesdk.
Hosted OneSDK URL Generation, used to request a hosted OneSDK URL with entity specific token for a customer to use a hosted OneSDK session to do an action. Examples of actions that may be done is to complete their onboarding process or to re-attempt IDV checks. If sendSMS is true and a phone number is supplied, an SMS will be sent to the phone number with the generated URL.
POST
/
v2
/
individuals
/
hostedurl
Provide hosted url for a hosted version of onesdk.
curl --request POST \
--url https://api.uat.frankie.one/v2/individuals/hostedurl \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"applicationRef": "<string>",
"channelRef": "<string>",
"consent": true,
"customerRef": "<string>",
"entityId": "<string>",
"errorRedirectURL": "<string>",
"pendingRedirectURL": "<string>",
"oneSDKFlowId": "<string>",
"phoneCode": "<string>",
"phoneNumber": "+6140000000",
"recipientName": "<string>",
"sendSMS": true,
"successRedirectURL": "<string>",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"requestedDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"optionalDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"partialDocuments": [
{
"title": "<string>",
"minimumRequirement": 123,
"documents": [
{
"documentType": "<string>",
"subType": "<string>"
}
]
}
]
}
'import requests
url = "https://api.uat.frankie.one/v2/individuals/hostedurl"
payload = {
"applicationRef": "<string>",
"channelRef": "<string>",
"consent": True,
"customerRef": "<string>",
"entityId": "<string>",
"errorRedirectURL": "<string>",
"pendingRedirectURL": "<string>",
"oneSDKFlowId": "<string>",
"phoneCode": "<string>",
"phoneNumber": "+6140000000",
"recipientName": "<string>",
"sendSMS": True,
"successRedirectURL": "<string>",
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
},
"requestedDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"optionalDocuments": [
{
"documentType": "<string>",
"subType": "<string>"
}
],
"partialDocuments": [
{
"title": "<string>",
"minimumRequirement": 123,
"documents": [
{
"documentType": "<string>",
"subType": "<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({
applicationRef: '<string>',
channelRef: '<string>',
consent: true,
customerRef: '<string>',
entityId: '<string>',
errorRedirectURL: '<string>',
pendingRedirectURL: '<string>',
oneSDKFlowId: '<string>',
phoneCode: '<string>',
phoneNumber: '+6140000000',
recipientName: '<string>',
sendSMS: true,
successRedirectURL: '<string>',
comment: {
text: 'Update after speaking to customer over the phone directly.',
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
},
requestedDocuments: [{documentType: '<string>', subType: '<string>'}],
optionalDocuments: [{documentType: '<string>', subType: '<string>'}],
partialDocuments: [
{
title: '<string>',
minimumRequirement: 123,
documents: [{documentType: '<string>', subType: '<string>'}]
}
]
})
};
fetch('https://api.uat.frankie.one/v2/individuals/hostedurl', 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.uat.frankie.one/v2/individuals/hostedurl",
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([
'applicationRef' => '<string>',
'channelRef' => '<string>',
'consent' => true,
'customerRef' => '<string>',
'entityId' => '<string>',
'errorRedirectURL' => '<string>',
'pendingRedirectURL' => '<string>',
'oneSDKFlowId' => '<string>',
'phoneCode' => '<string>',
'phoneNumber' => '+6140000000',
'recipientName' => '<string>',
'sendSMS' => true,
'successRedirectURL' => '<string>',
'comment' => [
'text' => 'Update after speaking to customer over the phone directly.',
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
],
'requestedDocuments' => [
[
'documentType' => '<string>',
'subType' => '<string>'
]
],
'optionalDocuments' => [
[
'documentType' => '<string>',
'subType' => '<string>'
]
],
'partialDocuments' => [
[
'title' => '<string>',
'minimumRequirement' => 123,
'documents' => [
[
'documentType' => '<string>',
'subType' => '<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.uat.frankie.one/v2/individuals/hostedurl"
payload := strings.NewReader("{\n \"applicationRef\": \"<string>\",\n \"channelRef\": \"<string>\",\n \"consent\": true,\n \"customerRef\": \"<string>\",\n \"entityId\": \"<string>\",\n \"errorRedirectURL\": \"<string>\",\n \"pendingRedirectURL\": \"<string>\",\n \"oneSDKFlowId\": \"<string>\",\n \"phoneCode\": \"<string>\",\n \"phoneNumber\": \"+6140000000\",\n \"recipientName\": \"<string>\",\n \"sendSMS\": true,\n \"successRedirectURL\": \"<string>\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"requestedDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"optionalDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"partialDocuments\": [\n {\n \"title\": \"<string>\",\n \"minimumRequirement\": 123,\n \"documents\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ]\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.uat.frankie.one/v2/individuals/hostedurl")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"applicationRef\": \"<string>\",\n \"channelRef\": \"<string>\",\n \"consent\": true,\n \"customerRef\": \"<string>\",\n \"entityId\": \"<string>\",\n \"errorRedirectURL\": \"<string>\",\n \"pendingRedirectURL\": \"<string>\",\n \"oneSDKFlowId\": \"<string>\",\n \"phoneCode\": \"<string>\",\n \"phoneNumber\": \"+6140000000\",\n \"recipientName\": \"<string>\",\n \"sendSMS\": true,\n \"successRedirectURL\": \"<string>\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"requestedDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"optionalDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"partialDocuments\": [\n {\n \"title\": \"<string>\",\n \"minimumRequirement\": 123,\n \"documents\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/individuals/hostedurl")
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 \"applicationRef\": \"<string>\",\n \"channelRef\": \"<string>\",\n \"consent\": true,\n \"customerRef\": \"<string>\",\n \"entityId\": \"<string>\",\n \"errorRedirectURL\": \"<string>\",\n \"pendingRedirectURL\": \"<string>\",\n \"oneSDKFlowId\": \"<string>\",\n \"phoneCode\": \"<string>\",\n \"phoneNumber\": \"+6140000000\",\n \"recipientName\": \"<string>\",\n \"sendSMS\": true,\n \"successRedirectURL\": \"<string>\",\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n },\n \"requestedDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"optionalDocuments\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ],\n \"partialDocuments\": [\n {\n \"title\": \"<string>\",\n \"minimumRequirement\": 123,\n \"documents\": [\n {\n \"documentType\": \"<string>\",\n \"subType\": \"<string>\"\n }\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"status": "<string>",
"url": "<string>",
"urlExpiry": "2020-01-01T00:00:00.000Z",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}Authorizations
Api-Keyjwt
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.
Body
application/json
Hosted OneSDK URL Request, used to request a hosted OneSDK URL with entity specific token for a customer to use a hosted OneSDK session to do an action. Examples of actions that may be done is to complete their onboarding process or to re-attempt IDV checks. If sendSMS is true and a phone number is supplied, an SMS will be sent to the phone number with the generated URL.
Reference or name of the application running this IDV check. Specify this if running this check embedded in a application rather than a web page.
channel this application is being submitted through, eg WEB, MOBILE
Has user consented for IDV check. If not supplied or is false, consent will need to be submitted via provider SDK.
external customer reference for this entity. If supplied and an entity id not, we will search for an entity with this customer ref. If not found, a new entity will be created with this customer ref.
Unique FrankieOne identifier for an entity if already created
if provider sdk fails, redirect to this url
if the process is still pending, redirect to this url
Flow id to use for OneSDK, to determine what data needs to be captured from the user, for example :"idv" or "ocr_only"
country phone code
phone code can be included with phone number or split out
Example:
"+6140000000"
if supplied will be used as the recipient name for the SMS
if true, will send an SMS to the phone number supplied
url to redirect to on success
Show child attributes
Show child attributes
List of documents that are requested from customer for onesdk session
Show child attributes
Show child attributes
List of documents that are optional from customer for onesdk session
Show child attributes
Show child attributes
List of documents that are partial from customer for onesdk session
Show child attributes
Show child attributes
Response
OK
Onboarding URL Response, contains the url for onboarding as well as the expiry. Each call to this endpoint will generate a new URL with a new expiry.
Status of the response for generating the onboarding URL and optionally sending via SMS.
URL to redirect the user to for onboarding, will point to a page where the user can complete their onboarding or IDV check.
The time at which the provided URL will expire according to configuration. Can not be set longer than 7 days
Example:
"2020-01-01T00:00:00.000Z"
The unique request identifier for the API call made.
Example:
"01HN9XHZN6MGXM9JXG50K59Q85"
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"
Was this page helpful?