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"
}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.
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"
}Headers
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
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.
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.
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.
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
Was this page helpful?