Get an IDV Token for the given individual.
curl --request POST \
--url https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5",
"provider": "onfido",
"products": "idv",
"vendorParameters": {},
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
'import requests
url = "https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token"
payload = {
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5",
"provider": "onfido",
"products": "idv",
"vendorParameters": {},
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
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({
applicantId: '412e8c806fdfb0bb19b5',
applicationId: '94d9a75a5072444c',
country: 'AUS',
documentType: 'DRIVER_LICENCE',
referrer: 'https://example.com',
relayState: '412e8c806fdfb0bb19b5',
provider: 'onfido',
products: 'idv',
vendorParameters: {},
comment: {
text: 'Update after speaking to customer over the phone directly.',
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
}
})
};
fetch('https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token', 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/{entityId}/actions/idv/token",
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([
'applicantId' => '412e8c806fdfb0bb19b5',
'applicationId' => '94d9a75a5072444c',
'country' => 'AUS',
'documentType' => 'DRIVER_LICENCE',
'referrer' => 'https://example.com',
'relayState' => '412e8c806fdfb0bb19b5',
'provider' => 'onfido',
'products' => 'idv',
'vendorParameters' => [
],
'comment' => [
'text' => 'Update after speaking to customer over the phone directly.',
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]
]),
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/{entityId}/actions/idv/token"
payload := strings.NewReader("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\",\n \"provider\": \"onfido\",\n \"products\": \"idv\",\n \"vendorParameters\": {},\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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/{entityId}/actions/idv/token")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\",\n \"provider\": \"onfido\",\n \"products\": \"idv\",\n \"vendorParameters\": {},\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token")
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 \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\",\n \"provider\": \"onfido\",\n \"products\": \"idv\",\n \"vendorParameters\": {},\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}"
response = http.request(request)
puts response.read_body{
"applicantId": "<string>",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"provider": "OCRLabs",
"smsSent": true,
"token": "41cf9401f0f889616bef",
"tokenExpiry": "2020-01-01T00:00:00.000Z",
"vendorParameters": {
"tokenURL": "example1.com"
},
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}IDV
Get an IDV Token for the given individual.
Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated, this is to be called before starting the IDV or OCR process.
POST
/
v2
/
individuals
/
{entityId}
/
actions
/
idv
/
token
Get an IDV Token for the given individual.
curl --request POST \
--url https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5",
"provider": "onfido",
"products": "idv",
"vendorParameters": {},
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
'import requests
url = "https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token"
payload = {
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5",
"provider": "onfido",
"products": "idv",
"vendorParameters": {},
"comment": {
"text": "Update after speaking to customer over the phone directly.",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
}
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({
applicantId: '412e8c806fdfb0bb19b5',
applicationId: '94d9a75a5072444c',
country: 'AUS',
documentType: 'DRIVER_LICENCE',
referrer: 'https://example.com',
relayState: '412e8c806fdfb0bb19b5',
provider: 'onfido',
products: 'idv',
vendorParameters: {},
comment: {
text: 'Update after speaking to customer over the phone directly.',
entityId: '3fa85f64-5717-4562-b3fc-2c963f66afa6'
}
})
};
fetch('https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token', 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/{entityId}/actions/idv/token",
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([
'applicantId' => '412e8c806fdfb0bb19b5',
'applicationId' => '94d9a75a5072444c',
'country' => 'AUS',
'documentType' => 'DRIVER_LICENCE',
'referrer' => 'https://example.com',
'relayState' => '412e8c806fdfb0bb19b5',
'provider' => 'onfido',
'products' => 'idv',
'vendorParameters' => [
],
'comment' => [
'text' => 'Update after speaking to customer over the phone directly.',
'entityId' => '3fa85f64-5717-4562-b3fc-2c963f66afa6'
]
]),
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/{entityId}/actions/idv/token"
payload := strings.NewReader("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\",\n \"provider\": \"onfido\",\n \"products\": \"idv\",\n \"vendorParameters\": {},\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\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/{entityId}/actions/idv/token")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\",\n \"provider\": \"onfido\",\n \"products\": \"idv\",\n \"vendorParameters\": {},\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/token")
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 \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\",\n \"provider\": \"onfido\",\n \"products\": \"idv\",\n \"vendorParameters\": {},\n \"comment\": {\n \"text\": \"Update after speaking to customer over the phone directly.\",\n \"entityId\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\"\n }\n}"
response = http.request(request)
puts response.read_body{
"applicantId": "<string>",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"provider": "OCRLabs",
"smsSent": true,
"token": "41cf9401f0f889616bef",
"tokenExpiry": "2020-01-01T00:00:00.000Z",
"vendorParameters": {
"tokenURL": "example1.com"
},
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}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.
Path Parameters
Unique FrankieOne identifier for an entity
Body
application/json
IDV Token Request, queries the IDV provider for a token to be used with their sdk. If there is an existing token for this given entity that isn't expired, that will be returned instead of a new token.
ID of the applicant/individual in the IDV provider's system. Specify this if resuming/continuing an IDV check
Example:
"412e8c806fdfb0bb19b5"
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.
Example:
"94d9a75a5072444c"
Country code to check for. Must be a ISO-3166 alpha-3 code entry. Only for use with providers that can restrict to a single country.
Example:
"AUS"
Document type that will be used for the check. Can be one of DRIVERS_LICENCE, PASSPORT, NATIONAL_ID. . Only for use with providers that can restrict to a single document type.
Example:
"DRIVER_LICENCE"
If this is for a web SDK, then you need to supply the referrer domain so that the token can be validated by the IDV service
Example:
"https://example.com"
State from start of flow that should be relayed through the process via any redirects.
Example:
"412e8c806fdfb0bb19b5"
What provider to use for the IDV check. This is the name of the provider as configured in the system. If not provided the default provider will be used.
Example:
"onfido"
What product(s) for the provider to use for the IDV check. If not provided the default product for a provider will be used.
Example:
"idv"
Vendor-specific parameters
Show child attributes
Show child attributes
Response
OK
IDV Token Response, contains the token and it's expiry, and any vendor specific parameters.
The ID of the applicant attached to this check.
Country code to check for. Must be a ISO-3166 alpha-3 code entry.
Example:
"AUS"
Document type that will be used for the check.
Example:
"DRIVER_LICENCE"
Underlying provider, used for selecting the correct SDK if not using SmartUI.
Example:
"OCRLabs"
Has a sms to the user already been sent as part of the token request
Example:
true
Tokens are only valid for a limited time.
Example:
"41cf9401f0f889616bef"
The time at which the provided token will expire.
Example:
"2020-01-01T00:00:00.000Z"
Vendor specific parameters, used for passing through additional parameters from the vendor to instantiate the SDK.
Show child attributes
Show child attributes
Example:
{ "tokenURL": "example1.com" }
The unique request identifier for the API call made.
Example:
"01HN9XHZN6MGXM9JXG50K59Q85"
Was this page helpful?