At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.
curl --request POST \
--url https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"token": "41cf9401f0f889616bef",
"providerReferenceId": "41cf9401f0f889616bef"
}
'import requests
url = "https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus"
payload = {
"token": "41cf9401f0f889616bef",
"providerReferenceId": "41cf9401f0f889616bef"
}
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({token: '41cf9401f0f889616bef', providerReferenceId: '41cf9401f0f889616bef'})
};
fetch('https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus', 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/checkstatus",
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([
'token' => '41cf9401f0f889616bef',
'providerReferenceId' => '41cf9401f0f889616bef'
]),
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/checkstatus"
payload := strings.NewReader("{\n \"token\": \"41cf9401f0f889616bef\",\n \"providerReferenceId\": \"41cf9401f0f889616bef\"\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/checkstatus")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"token\": \"41cf9401f0f889616bef\",\n \"providerReferenceId\": \"41cf9401f0f889616bef\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus")
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 \"token\": \"41cf9401f0f889616bef\",\n \"providerReferenceId\": \"41cf9401f0f889616bef\"\n}"
response = http.request(request)
puts response.read_body{
"status": "COMPLETE",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"workflowExecutionId": "<string>",
"ocrResult": {
"processResultId": "<string>",
"schemaVersion": 123,
"entityId": "<string>",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"stepName": "<string>",
"stepType": "<string>",
"objectType": "<string>",
"objectId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"groupId": "<string>",
"providerResult": {
"name": "<string>",
"source": "<string>",
"sourceNormalized": "<string>",
"reference": "<string>",
"fuzziness": {
"normalized": 50,
"actual": "<string>"
},
"confidence": {
"normalized": 50,
"actual": "<string>"
},
"riskScore": 123,
"errorCode": "<string>",
"errorMessage": "<string>"
},
"result": "MATCH",
"class": "KYC",
"subClass": "<string>",
"supplementaryData": {
"type": "AML",
"serviceProvider": "<string>",
"searchId": "<string>",
"caseId": "<string>",
"referenceId": "<string>",
"originalStepSearchLevel": "<string>",
"groupingId": "<string>",
"reportUrl": "<string>",
"fuzziness": {
"normalized": 50,
"actual": "<string>"
},
"matchData": {
"spReferenceId": "<string>",
"name": "<string>",
"strength": 123,
"givenName": "<string>",
"otherName": "<string>",
"familyName": "<string>",
"date": "<string>",
"address": "<string>",
"countries": [
{
"code": "<string>",
"matchType": "<string>"
}
],
"nationalId": {
"idNumber": "<string>",
"idType": "<string>",
"idExpiry": "<string>",
"issuingCountryCode": "<string>",
"documentId": "<string>"
},
"imageUrl": "<string>",
"isDeceased": true,
"isAlias": true,
"isRelated": true,
"gender": "MALE"
},
"aliases": [
"<string>"
],
"relatedParties": [
{
"name": "<string>",
"relationship": "<string>"
}
],
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"notes": {},
"pepData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"level": "<string>",
"sourceUrl": "<string>",
"sourcePosition": "<string>",
"position": "<string>",
"positionDescription": "<string>",
"status": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"sanctionData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"sourceUrl": "<string>",
"sourceReason": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"watchlistData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"sourceUrl": "<string>",
"sourceReason": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"mediaData": [
{
"title": "<string>",
"source": "<string>",
"snippet": "<string>",
"sourceDate": "<string>",
"sourceCountry": "<string>",
"url": "<string>",
"isCurrent": true
}
]
},
"errors": [
{
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"notes": {},
"systemStatus": "VALID",
"state": "IN_PROGRESS",
"riskFactors": [
{
"factor": "<string>",
"value": "<string>"
}
],
"updatedBy": "<string>"
}
}IDV
At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.
At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check. If this call is successful, an entity is populated with with any details supplied if it doesn’t not already have a name.
POST
/
v2
/
individuals
/
{entityId}
/
actions
/
idv
/
checkstatus
At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider that check is ready to analyse and check.
curl --request POST \
--url https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"token": "41cf9401f0f889616bef",
"providerReferenceId": "41cf9401f0f889616bef"
}
'import requests
url = "https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus"
payload = {
"token": "41cf9401f0f889616bef",
"providerReferenceId": "41cf9401f0f889616bef"
}
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({token: '41cf9401f0f889616bef', providerReferenceId: '41cf9401f0f889616bef'})
};
fetch('https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus', 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/checkstatus",
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([
'token' => '41cf9401f0f889616bef',
'providerReferenceId' => '41cf9401f0f889616bef'
]),
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/checkstatus"
payload := strings.NewReader("{\n \"token\": \"41cf9401f0f889616bef\",\n \"providerReferenceId\": \"41cf9401f0f889616bef\"\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/checkstatus")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"token\": \"41cf9401f0f889616bef\",\n \"providerReferenceId\": \"41cf9401f0f889616bef\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/individuals/{entityId}/actions/idv/checkstatus")
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 \"token\": \"41cf9401f0f889616bef\",\n \"providerReferenceId\": \"41cf9401f0f889616bef\"\n}"
response = http.request(request)
puts response.read_body{
"status": "COMPLETE",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"workflowExecutionId": "<string>",
"ocrResult": {
"processResultId": "<string>",
"schemaVersion": 123,
"entityId": "<string>",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"stepName": "<string>",
"stepType": "<string>",
"objectType": "<string>",
"objectId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"groupId": "<string>",
"providerResult": {
"name": "<string>",
"source": "<string>",
"sourceNormalized": "<string>",
"reference": "<string>",
"fuzziness": {
"normalized": 50,
"actual": "<string>"
},
"confidence": {
"normalized": 50,
"actual": "<string>"
},
"riskScore": 123,
"errorCode": "<string>",
"errorMessage": "<string>"
},
"result": "MATCH",
"class": "KYC",
"subClass": "<string>",
"supplementaryData": {
"type": "AML",
"serviceProvider": "<string>",
"searchId": "<string>",
"caseId": "<string>",
"referenceId": "<string>",
"originalStepSearchLevel": "<string>",
"groupingId": "<string>",
"reportUrl": "<string>",
"fuzziness": {
"normalized": 50,
"actual": "<string>"
},
"matchData": {
"spReferenceId": "<string>",
"name": "<string>",
"strength": 123,
"givenName": "<string>",
"otherName": "<string>",
"familyName": "<string>",
"date": "<string>",
"address": "<string>",
"countries": [
{
"code": "<string>",
"matchType": "<string>"
}
],
"nationalId": {
"idNumber": "<string>",
"idType": "<string>",
"idExpiry": "<string>",
"issuingCountryCode": "<string>",
"documentId": "<string>"
},
"imageUrl": "<string>",
"isDeceased": true,
"isAlias": true,
"isRelated": true,
"gender": "MALE"
},
"aliases": [
"<string>"
],
"relatedParties": [
{
"name": "<string>",
"relationship": "<string>"
}
],
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"notes": {},
"pepData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"level": "<string>",
"sourceUrl": "<string>",
"sourcePosition": "<string>",
"position": "<string>",
"positionDescription": "<string>",
"status": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"sanctionData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"sourceUrl": "<string>",
"sourceReason": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"watchlistData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"sourceUrl": "<string>",
"sourceReason": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"mediaData": [
{
"title": "<string>",
"source": "<string>",
"snippet": "<string>",
"sourceDate": "<string>",
"sourceCountry": "<string>",
"url": "<string>",
"isCurrent": true
}
]
},
"errors": [
{
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"notes": {},
"systemStatus": "VALID",
"state": "IN_PROGRESS",
"riskFactors": [
{
"factor": "<string>",
"value": "<string>"
}
],
"updatedBy": "<string>"
}
}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
Response
OK
IDV check status response
Status of the process. Status can be one of:
- IN_PROGRESS - the provider has been sent the request and is currently still processing the result
- CHECK_PROCESSING_DOWNLOAD_FAIL - the provider has been sent the request and is currently still processing the result, there was an issue downloading the images that will be retried later automatically
- WAITING_SELFIE_UPLOAD - the selfie has not been uploaded yet by the applicant, still awaiting applicant action
- CHECK_PROCESSING - the provider has been sent the request and is currently still processing the result
- DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT - the document is too large to be processed
- DOCUMENT_INVALID_INCORRECT_FILE_FORMAT - the document is not a supported file format, mostly only jpeg and png are supported but this is provider specific
- PROVIDER_OFFLINE - the provider is not available for processing the request
- COMPLETE - process is valid and completed
Available options:
IN_PROGRESS, CHECK_PROCESSING_DOWNLOAD_FAIL, WAITING_SELFIE_UPLOAD, CHECK_PROCESSING, DOCUMENT_INVALID_EXCEEDED_SIZE_LIMIT, DOCUMENT_INVALID_INCORRECT_FILE_FORMAT, PROVIDER_OFFLINE, COMPLETE Example:
"COMPLETE"
The unique request identifier for the API call made.
Example:
"01HN9XHZN6MGXM9JXG50K59Q85"
If a workflow was run as part of the processing, this is the workflow execution id
Show child attributes
Show child attributes
Was this page helpful?