Retrieve a token to use with a check
curl --request POST \
--url https://api.uat.frankie.one/idv/v2/idvalidate/token \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"consent": true,
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"entity": {
"addresses": [
{
"addressId": "<string>",
"addressType": "<string>",
"buildingName": "<string>",
"careOf": "<string>",
"country": "<string>",
"endDate": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"longForm": "<string>",
"postalCode": "<string>",
"region": "<string>",
"startDate": "<string>",
"state": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"suburb": "<string>",
"town": "<string>",
"unitNumber": "<string>",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "<string>",
"dateOfBirth": "<string>",
"locality": "<string>",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "<string>"
},
"entityId": "<string>",
"entityProfile": "<string>",
"entityType": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "<string>",
"identityDocs": [
{
"country": "<string>",
"createdFromScan": true,
"docScan": [
{
"ScanDelete": true,
"scanCreated": "<string>",
"scanData": "<string>",
"scanDataRetrievalState": "<string>",
"scanDocId": "<string>",
"scanFilename": "<string>",
"scanMIME": "<string>",
"scanPageNum": 123,
"scanSide": "<string>",
"scanType": "<string>"
}
],
"documentId": "<string>",
"documentStatus": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"idExpiry": "<string>",
"idIssued": "<string>",
"idNumber": "<string>",
"idSubType": "<string>",
"idType": "<string>",
"manuallyModified": true,
"region": "<string>"
}
],
"name": {
"displayName": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"honourific": "<string>",
"middleName": "<string>"
},
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"blockingReasons": [
{
"candidates": [
{
"address": "<string>",
"code": "<string>",
"countryIso": "<string>",
"registeredName": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
],
"description": "<string>",
"type": "<string>"
}
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "<string>",
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"normalisedLegalStatus": "<string>",
"ownershipResolved": true,
"registeredName": "<string>",
"registration": {
"countryIso": "<string>",
"date": "<string>",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "<string>",
"endorsedTo": "<string>"
}
],
"gst": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "<string>",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "<string>",
"name": "<string>",
"registeredDate": "<string>",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "<string>"
}
},
"reviewDate": "<string>",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "<string>",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5"
}
'import requests
url = "https://api.uat.frankie.one/idv/v2/idvalidate/token"
payload = {
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"consent": True,
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"entity": {
"addresses": [
{
"addressId": "<string>",
"addressType": "<string>",
"buildingName": "<string>",
"careOf": "<string>",
"country": "<string>",
"endDate": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"longForm": "<string>",
"postalCode": "<string>",
"region": "<string>",
"startDate": "<string>",
"state": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"suburb": "<string>",
"town": "<string>",
"unitNumber": "<string>",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "<string>",
"dateOfBirth": "<string>",
"locality": "<string>",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "<string>"
},
"entityId": "<string>",
"entityProfile": "<string>",
"entityType": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "<string>",
"identityDocs": [
{
"country": "<string>",
"createdFromScan": True,
"docScan": [
{
"ScanDelete": True,
"scanCreated": "<string>",
"scanData": "<string>",
"scanDataRetrievalState": "<string>",
"scanDocId": "<string>",
"scanFilename": "<string>",
"scanMIME": "<string>",
"scanPageNum": 123,
"scanSide": "<string>",
"scanType": "<string>"
}
],
"documentId": "<string>",
"documentStatus": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"idExpiry": "<string>",
"idIssued": "<string>",
"idNumber": "<string>",
"idSubType": "<string>",
"idType": "<string>",
"manuallyModified": True,
"region": "<string>"
}
],
"name": {
"displayName": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"honourific": "<string>",
"middleName": "<string>"
},
"organisationData": {
"adverseCreditDataPresent": True,
"aliases": ["<string>"],
"blockingReasons": [
{
"candidates": [
{
"address": "<string>",
"code": "<string>",
"countryIso": "<string>",
"registeredName": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
],
"description": "<string>",
"type": "<string>"
}
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": True,
"includesNonBeneficiallyHeld": True,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "<string>",
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"normalisedLegalStatus": "<string>",
"ownershipResolved": True,
"registeredName": "<string>",
"registration": {
"countryIso": "<string>",
"date": "<string>",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": { "abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "<string>",
"endorsedTo": "<string>"
}
],
"gst": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"historicalChanges": [
{
"businessName": ["<string>"],
"date": "<string>",
"entityStatus": ["<string>"],
"goodsAndServicesTax": ["<string>"],
"mainBusinessPhysicalAddress": ["<string>"],
"mainName": ["<string>"],
"mainTradingName": ["<string>"]
}
],
"lastUpdated": "<string>",
"name": "<string>",
"registeredDate": "<string>",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "<string>"
} },
"reviewDate": "<string>",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "<string>",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5"
}
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Frankie-CustomerID': '<x-frankie-customerid>',
api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
applicantId: '412e8c806fdfb0bb19b5',
applicationId: '94d9a75a5072444c',
consent: true,
country: 'AUS',
documentType: 'DRIVER_LICENCE',
entity: {
addresses: [
{
addressId: '<string>',
addressType: '<string>',
buildingName: '<string>',
careOf: '<string>',
country: '<string>',
endDate: '<string>',
extraData: [{kvpKey: '<string>', kvpType: '<string>', kvpValue: '<string>'}],
longForm: '<string>',
postalCode: '<string>',
region: '<string>',
startDate: '<string>',
state: '<string>',
streetName: '<string>',
streetNumber: '<string>',
streetType: '<string>',
suburb: '<string>',
town: '<string>',
unitNumber: '<string>',
unstructuredLongForm: '<string>'
}
],
dateOfBirth: {
country: '<string>',
dateOfBirth: '<string>',
locality: '<string>',
unstructuredDateOfBirth: '<string>',
yearOfBirth: '<string>'
},
entityId: '<string>',
entityProfile: '<string>',
entityType: '<string>',
extraData: [{kvpKey: '<string>', kvpType: '<string>', kvpValue: '<string>'}],
flags: [{flag: '<string>', value: 123}],
gender: '<string>',
identityDocs: [
{
country: '<string>',
createdFromScan: true,
docScan: [
{
ScanDelete: true,
scanCreated: '<string>',
scanData: '<string>',
scanDataRetrievalState: '<string>',
scanDocId: '<string>',
scanFilename: '<string>',
scanMIME: '<string>',
scanPageNum: 123,
scanSide: '<string>',
scanType: '<string>'
}
],
documentId: '<string>',
documentStatus: '<string>',
extraData: [{kvpKey: '<string>', kvpType: '<string>', kvpValue: '<string>'}],
idExpiry: '<string>',
idIssued: '<string>',
idNumber: '<string>',
idSubType: '<string>',
idType: '<string>',
manuallyModified: true,
region: '<string>'
}
],
name: {
displayName: '<string>',
familyName: '<string>',
givenName: '<string>',
honourific: '<string>',
middleName: '<string>'
},
organisationData: {
adverseCreditDataPresent: true,
aliases: ['<string>'],
blockingReasons: [
{
candidates: [
{
address: '<string>',
code: '<string>',
countryIso: '<string>',
registeredName: '<string>',
registryDescription: '<string>',
subdivision: '<string>'
}
],
description: '<string>',
type: '<string>'
}
],
class: {code: '<string>', description: '<string>'},
contactDetails: {
email: '<string>',
faxNumber: '<string>',
telephoneNumber: '<string>',
websiteURL: '<string>'
},
disclosingEntityIndicator: true,
includesNonBeneficiallyHeld: true,
industryCodes: [{code: '<string>', description: '<string>'}],
industryDeclarations: [{description: '<string>', language: '<string>'}],
kycCustomerType: '<string>',
lastCheckDate: '<string>',
legalFormDetails: {
basis: '<string>',
capital: '<string>',
comments: '<string>',
control: '<string>',
incorp: '<string>',
partner: '<string>',
responsibility: '<string>',
stocks: '<string>'
},
normalisedLegalStatus: '<string>',
ownershipResolved: true,
registeredName: '<string>',
registration: {
countryIso: '<string>',
date: '<string>',
number: '<string>',
previousNumber: '<string>',
registryCode: '<string>',
registryDescription: '<string>',
state: '<string>',
unstructuredDate: '<string>',
unstructuredFoundationDate: '<string>'
},
registries: {
abr: {
abn: '<string>',
acn: '<string>',
addresses: [
{
effectiveFrom: '<string>',
effectiveTo: '<string>',
postcode: '<string>',
stateCode: '<string>'
}
],
businessNames: [
{
effectiveFrom: '<string>',
effectiveTo: '<string>',
name: '<string>',
type: '<string>'
}
],
charityEndorsements: [{effectiveFrom: '<string>', effectiveTo: '<string>', type: '<string>'}],
charityTypes: [{description: '<string>', effectiveFrom: '<string>', effectiveTo: '<string>'}],
description: '<string>',
dgrEndorsements: [{endorsedFrom: '<string>', endorsedTo: '<string>'}],
gst: [{effectiveFrom: '<string>', effectiveTo: '<string>'}],
historicalChanges: [
{
businessName: ['<string>'],
date: '<string>',
entityStatus: ['<string>'],
goodsAndServicesTax: ['<string>'],
mainBusinessPhysicalAddress: ['<string>'],
mainName: ['<string>'],
mainTradingName: ['<string>']
}
],
lastUpdated: '<string>',
name: '<string>',
registeredDate: '<string>',
status: '<string>',
statusEffectiveFrom: '<string>',
type: '<string>',
typeCode: '<string>',
updatedDate: '<string>'
}
},
reviewDate: '<string>',
shareStructure: [
{
amountDue: 123,
amountPaid: 123,
classCode: '<string>',
classTitle: '<string>',
docNumber: '<string>',
docNumberQualifier: '<string>',
sharesIssued: 123,
status: '<string>'
}
],
startDate: '<string>',
status: {code: '<string>', description: '<string>'},
subType: {code: '<string>', description: '<string>'},
subclass: {code: '<string>', description: '<string>'},
type: {code: '<string>', description: '<string>'}
}
},
referrer: 'https://example.com',
relayState: '412e8c806fdfb0bb19b5'
})
};
fetch('https://api.uat.frankie.one/idv/v2/idvalidate/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/idv/v2/idvalidate/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',
'consent' => true,
'country' => 'AUS',
'documentType' => 'DRIVER_LICENCE',
'entity' => [
'addresses' => [
[
'addressId' => '<string>',
'addressType' => '<string>',
'buildingName' => '<string>',
'careOf' => '<string>',
'country' => '<string>',
'endDate' => '<string>',
'extraData' => [
[
'kvpKey' => '<string>',
'kvpType' => '<string>',
'kvpValue' => '<string>'
]
],
'longForm' => '<string>',
'postalCode' => '<string>',
'region' => '<string>',
'startDate' => '<string>',
'state' => '<string>',
'streetName' => '<string>',
'streetNumber' => '<string>',
'streetType' => '<string>',
'suburb' => '<string>',
'town' => '<string>',
'unitNumber' => '<string>',
'unstructuredLongForm' => '<string>'
]
],
'dateOfBirth' => [
'country' => '<string>',
'dateOfBirth' => '<string>',
'locality' => '<string>',
'unstructuredDateOfBirth' => '<string>',
'yearOfBirth' => '<string>'
],
'entityId' => '<string>',
'entityProfile' => '<string>',
'entityType' => '<string>',
'extraData' => [
[
'kvpKey' => '<string>',
'kvpType' => '<string>',
'kvpValue' => '<string>'
]
],
'flags' => [
[
'flag' => '<string>',
'value' => 123
]
],
'gender' => '<string>',
'identityDocs' => [
[
'country' => '<string>',
'createdFromScan' => true,
'docScan' => [
[
'ScanDelete' => true,
'scanCreated' => '<string>',
'scanData' => '<string>',
'scanDataRetrievalState' => '<string>',
'scanDocId' => '<string>',
'scanFilename' => '<string>',
'scanMIME' => '<string>',
'scanPageNum' => 123,
'scanSide' => '<string>',
'scanType' => '<string>'
]
],
'documentId' => '<string>',
'documentStatus' => '<string>',
'extraData' => [
[
'kvpKey' => '<string>',
'kvpType' => '<string>',
'kvpValue' => '<string>'
]
],
'idExpiry' => '<string>',
'idIssued' => '<string>',
'idNumber' => '<string>',
'idSubType' => '<string>',
'idType' => '<string>',
'manuallyModified' => true,
'region' => '<string>'
]
],
'name' => [
'displayName' => '<string>',
'familyName' => '<string>',
'givenName' => '<string>',
'honourific' => '<string>',
'middleName' => '<string>'
],
'organisationData' => [
'adverseCreditDataPresent' => true,
'aliases' => [
'<string>'
],
'blockingReasons' => [
[
'candidates' => [
[
'address' => '<string>',
'code' => '<string>',
'countryIso' => '<string>',
'registeredName' => '<string>',
'registryDescription' => '<string>',
'subdivision' => '<string>'
]
],
'description' => '<string>',
'type' => '<string>'
]
],
'class' => [
'code' => '<string>',
'description' => '<string>'
],
'contactDetails' => [
'email' => '<string>',
'faxNumber' => '<string>',
'telephoneNumber' => '<string>',
'websiteURL' => '<string>'
],
'disclosingEntityIndicator' => true,
'includesNonBeneficiallyHeld' => true,
'industryCodes' => [
[
'code' => '<string>',
'description' => '<string>'
]
],
'industryDeclarations' => [
[
'description' => '<string>',
'language' => '<string>'
]
],
'kycCustomerType' => '<string>',
'lastCheckDate' => '<string>',
'legalFormDetails' => [
'basis' => '<string>',
'capital' => '<string>',
'comments' => '<string>',
'control' => '<string>',
'incorp' => '<string>',
'partner' => '<string>',
'responsibility' => '<string>',
'stocks' => '<string>'
],
'normalisedLegalStatus' => '<string>',
'ownershipResolved' => true,
'registeredName' => '<string>',
'registration' => [
'countryIso' => '<string>',
'date' => '<string>',
'number' => '<string>',
'previousNumber' => '<string>',
'registryCode' => '<string>',
'registryDescription' => '<string>',
'state' => '<string>',
'unstructuredDate' => '<string>',
'unstructuredFoundationDate' => '<string>'
],
'registries' => [
'abr' => [
'abn' => '<string>',
'acn' => '<string>',
'addresses' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>',
'postcode' => '<string>',
'stateCode' => '<string>'
]
],
'businessNames' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
],
'charityEndorsements' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>',
'type' => '<string>'
]
],
'charityTypes' => [
[
'description' => '<string>',
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>'
]
],
'description' => '<string>',
'dgrEndorsements' => [
[
'endorsedFrom' => '<string>',
'endorsedTo' => '<string>'
]
],
'gst' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>'
]
],
'historicalChanges' => [
[
'businessName' => [
'<string>'
],
'date' => '<string>',
'entityStatus' => [
'<string>'
],
'goodsAndServicesTax' => [
'<string>'
],
'mainBusinessPhysicalAddress' => [
'<string>'
],
'mainName' => [
'<string>'
],
'mainTradingName' => [
'<string>'
]
]
],
'lastUpdated' => '<string>',
'name' => '<string>',
'registeredDate' => '<string>',
'status' => '<string>',
'statusEffectiveFrom' => '<string>',
'type' => '<string>',
'typeCode' => '<string>',
'updatedDate' => '<string>'
]
],
'reviewDate' => '<string>',
'shareStructure' => [
[
'amountDue' => 123,
'amountPaid' => 123,
'classCode' => '<string>',
'classTitle' => '<string>',
'docNumber' => '<string>',
'docNumberQualifier' => '<string>',
'sharesIssued' => 123,
'status' => '<string>'
]
],
'startDate' => '<string>',
'status' => [
'code' => '<string>',
'description' => '<string>'
],
'subType' => [
'code' => '<string>',
'description' => '<string>'
],
'subclass' => [
'code' => '<string>',
'description' => '<string>'
],
'type' => [
'code' => '<string>',
'description' => '<string>'
]
]
],
'referrer' => 'https://example.com',
'relayState' => '412e8c806fdfb0bb19b5'
]),
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/idv/v2/idvalidate/token"
payload := strings.NewReader("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"consent\": true,\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"entity\": {\n \"addresses\": [\n {\n \"addressId\": \"<string>\",\n \"addressType\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"careOf\": \"<string>\",\n \"country\": \"<string>\",\n \"endDate\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"longForm\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"startDate\": \"<string>\",\n \"state\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"suburb\": \"<string>\",\n \"town\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"locality\": \"<string>\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"<string>\"\n },\n \"entityId\": \"<string>\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"<string>\",\n \"identityDocs\": [\n {\n \"country\": \"<string>\",\n \"createdFromScan\": true,\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"<string>\",\n \"scanData\": \"<string>\",\n \"scanDataRetrievalState\": \"<string>\",\n \"scanDocId\": \"<string>\",\n \"scanFilename\": \"<string>\",\n \"scanMIME\": \"<string>\",\n \"scanPageNum\": 123,\n \"scanSide\": \"<string>\",\n \"scanType\": \"<string>\"\n }\n ],\n \"documentId\": \"<string>\",\n \"documentStatus\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"idExpiry\": \"<string>\",\n \"idIssued\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"idSubType\": \"<string>\",\n \"idType\": \"<string>\",\n \"manuallyModified\": true,\n \"region\": \"<string>\"\n }\n ],\n \"name\": {\n \"displayName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"honourific\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\n ],\n \"blockingReasons\": [\n {\n \"candidates\": [\n {\n \"address\": \"<string>\",\n \"code\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"registeredName\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"subdivision\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"class\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"contactDetails\": {\n \"email\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"telephoneNumber\": \"<string>\",\n \"websiteURL\": \"<string>\"\n },\n \"disclosingEntityIndicator\": true,\n \"includesNonBeneficiallyHeld\": true,\n \"industryCodes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"industryDeclarations\": [\n {\n \"description\": \"<string>\",\n \"language\": \"<string>\"\n }\n ],\n \"kycCustomerType\": \"<string>\",\n \"lastCheckDate\": \"<string>\",\n \"legalFormDetails\": {\n \"basis\": \"<string>\",\n \"capital\": \"<string>\",\n \"comments\": \"<string>\",\n \"control\": \"<string>\",\n \"incorp\": \"<string>\",\n \"partner\": \"<string>\",\n \"responsibility\": \"<string>\",\n \"stocks\": \"<string>\"\n },\n \"normalisedLegalStatus\": \"<string>\",\n \"ownershipResolved\": true,\n \"registeredName\": \"<string>\",\n \"registration\": {\n \"countryIso\": \"<string>\",\n \"date\": \"<string>\",\n \"number\": \"<string>\",\n \"previousNumber\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"state\": \"<string>\",\n \"unstructuredDate\": \"<string>\",\n \"unstructuredFoundationDate\": \"<string>\"\n },\n \"registries\": {\n \"abr\": {\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"addresses\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"<string>\",\n \"endorsedTo\": \"<string>\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"<string>\",\n \"entityStatus\": [\n \"<string>\"\n ],\n \"goodsAndServicesTax\": [\n \"<string>\"\n ],\n \"mainBusinessPhysicalAddress\": [\n \"<string>\"\n ],\n \"mainName\": [\n \"<string>\"\n ],\n \"mainTradingName\": [\n \"<string>\"\n ]\n }\n ],\n \"lastUpdated\": \"<string>\",\n \"name\": \"<string>\",\n \"registeredDate\": \"<string>\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"<string>\"\n }\n },\n \"reviewDate\": \"<string>\",\n \"shareStructure\": [\n {\n \"amountDue\": 123,\n \"amountPaid\": 123,\n \"classCode\": \"<string>\",\n \"classTitle\": \"<string>\",\n \"docNumber\": \"<string>\",\n \"docNumberQualifier\": \"<string>\",\n \"sharesIssued\": 123,\n \"status\": \"<string>\"\n }\n ],\n \"startDate\": \"<string>\",\n \"status\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subType\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subclass\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"type\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n }\n },\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("api_key", "<api-key>")
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/idv/v2/idvalidate/token")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"consent\": true,\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"entity\": {\n \"addresses\": [\n {\n \"addressId\": \"<string>\",\n \"addressType\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"careOf\": \"<string>\",\n \"country\": \"<string>\",\n \"endDate\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"longForm\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"startDate\": \"<string>\",\n \"state\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"suburb\": \"<string>\",\n \"town\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"locality\": \"<string>\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"<string>\"\n },\n \"entityId\": \"<string>\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"<string>\",\n \"identityDocs\": [\n {\n \"country\": \"<string>\",\n \"createdFromScan\": true,\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"<string>\",\n \"scanData\": \"<string>\",\n \"scanDataRetrievalState\": \"<string>\",\n \"scanDocId\": \"<string>\",\n \"scanFilename\": \"<string>\",\n \"scanMIME\": \"<string>\",\n \"scanPageNum\": 123,\n \"scanSide\": \"<string>\",\n \"scanType\": \"<string>\"\n }\n ],\n \"documentId\": \"<string>\",\n \"documentStatus\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"idExpiry\": \"<string>\",\n \"idIssued\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"idSubType\": \"<string>\",\n \"idType\": \"<string>\",\n \"manuallyModified\": true,\n \"region\": \"<string>\"\n }\n ],\n \"name\": {\n \"displayName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"honourific\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\n ],\n \"blockingReasons\": [\n {\n \"candidates\": [\n {\n \"address\": \"<string>\",\n \"code\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"registeredName\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"subdivision\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"class\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"contactDetails\": {\n \"email\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"telephoneNumber\": \"<string>\",\n \"websiteURL\": \"<string>\"\n },\n \"disclosingEntityIndicator\": true,\n \"includesNonBeneficiallyHeld\": true,\n \"industryCodes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"industryDeclarations\": [\n {\n \"description\": \"<string>\",\n \"language\": \"<string>\"\n }\n ],\n \"kycCustomerType\": \"<string>\",\n \"lastCheckDate\": \"<string>\",\n \"legalFormDetails\": {\n \"basis\": \"<string>\",\n \"capital\": \"<string>\",\n \"comments\": \"<string>\",\n \"control\": \"<string>\",\n \"incorp\": \"<string>\",\n \"partner\": \"<string>\",\n \"responsibility\": \"<string>\",\n \"stocks\": \"<string>\"\n },\n \"normalisedLegalStatus\": \"<string>\",\n \"ownershipResolved\": true,\n \"registeredName\": \"<string>\",\n \"registration\": {\n \"countryIso\": \"<string>\",\n \"date\": \"<string>\",\n \"number\": \"<string>\",\n \"previousNumber\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"state\": \"<string>\",\n \"unstructuredDate\": \"<string>\",\n \"unstructuredFoundationDate\": \"<string>\"\n },\n \"registries\": {\n \"abr\": {\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"addresses\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"<string>\",\n \"endorsedTo\": \"<string>\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"<string>\",\n \"entityStatus\": [\n \"<string>\"\n ],\n \"goodsAndServicesTax\": [\n \"<string>\"\n ],\n \"mainBusinessPhysicalAddress\": [\n \"<string>\"\n ],\n \"mainName\": [\n \"<string>\"\n ],\n \"mainTradingName\": [\n \"<string>\"\n ]\n }\n ],\n \"lastUpdated\": \"<string>\",\n \"name\": \"<string>\",\n \"registeredDate\": \"<string>\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"<string>\"\n }\n },\n \"reviewDate\": \"<string>\",\n \"shareStructure\": [\n {\n \"amountDue\": 123,\n \"amountPaid\": 123,\n \"classCode\": \"<string>\",\n \"classTitle\": \"<string>\",\n \"docNumber\": \"<string>\",\n \"docNumberQualifier\": \"<string>\",\n \"sharesIssued\": 123,\n \"status\": \"<string>\"\n }\n ],\n \"startDate\": \"<string>\",\n \"status\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subType\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subclass\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"type\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n }\n },\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/idv/v2/idvalidate/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"consent\": true,\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"entity\": {\n \"addresses\": [\n {\n \"addressId\": \"<string>\",\n \"addressType\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"careOf\": \"<string>\",\n \"country\": \"<string>\",\n \"endDate\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"longForm\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"startDate\": \"<string>\",\n \"state\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"suburb\": \"<string>\",\n \"town\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"locality\": \"<string>\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"<string>\"\n },\n \"entityId\": \"<string>\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"<string>\",\n \"identityDocs\": [\n {\n \"country\": \"<string>\",\n \"createdFromScan\": true,\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"<string>\",\n \"scanData\": \"<string>\",\n \"scanDataRetrievalState\": \"<string>\",\n \"scanDocId\": \"<string>\",\n \"scanFilename\": \"<string>\",\n \"scanMIME\": \"<string>\",\n \"scanPageNum\": 123,\n \"scanSide\": \"<string>\",\n \"scanType\": \"<string>\"\n }\n ],\n \"documentId\": \"<string>\",\n \"documentStatus\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"idExpiry\": \"<string>\",\n \"idIssued\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"idSubType\": \"<string>\",\n \"idType\": \"<string>\",\n \"manuallyModified\": true,\n \"region\": \"<string>\"\n }\n ],\n \"name\": {\n \"displayName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"honourific\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\n ],\n \"blockingReasons\": [\n {\n \"candidates\": [\n {\n \"address\": \"<string>\",\n \"code\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"registeredName\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"subdivision\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"class\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"contactDetails\": {\n \"email\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"telephoneNumber\": \"<string>\",\n \"websiteURL\": \"<string>\"\n },\n \"disclosingEntityIndicator\": true,\n \"includesNonBeneficiallyHeld\": true,\n \"industryCodes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"industryDeclarations\": [\n {\n \"description\": \"<string>\",\n \"language\": \"<string>\"\n }\n ],\n \"kycCustomerType\": \"<string>\",\n \"lastCheckDate\": \"<string>\",\n \"legalFormDetails\": {\n \"basis\": \"<string>\",\n \"capital\": \"<string>\",\n \"comments\": \"<string>\",\n \"control\": \"<string>\",\n \"incorp\": \"<string>\",\n \"partner\": \"<string>\",\n \"responsibility\": \"<string>\",\n \"stocks\": \"<string>\"\n },\n \"normalisedLegalStatus\": \"<string>\",\n \"ownershipResolved\": true,\n \"registeredName\": \"<string>\",\n \"registration\": {\n \"countryIso\": \"<string>\",\n \"date\": \"<string>\",\n \"number\": \"<string>\",\n \"previousNumber\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"state\": \"<string>\",\n \"unstructuredDate\": \"<string>\",\n \"unstructuredFoundationDate\": \"<string>\"\n },\n \"registries\": {\n \"abr\": {\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"addresses\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"<string>\",\n \"endorsedTo\": \"<string>\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"<string>\",\n \"entityStatus\": [\n \"<string>\"\n ],\n \"goodsAndServicesTax\": [\n \"<string>\"\n ],\n \"mainBusinessPhysicalAddress\": [\n \"<string>\"\n ],\n \"mainName\": [\n \"<string>\"\n ],\n \"mainTradingName\": [\n \"<string>\"\n ]\n }\n ],\n \"lastUpdated\": \"<string>\",\n \"name\": \"<string>\",\n \"registeredDate\": \"<string>\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"<string>\"\n }\n },\n \"reviewDate\": \"<string>\",\n \"shareStructure\": [\n {\n \"amountDue\": 123,\n \"amountPaid\": 123,\n \"classCode\": \"<string>\",\n \"classTitle\": \"<string>\",\n \"docNumber\": \"<string>\",\n \"docNumberQualifier\": \"<string>\",\n \"sharesIssued\": 123,\n \"status\": \"<string>\"\n }\n ],\n \"startDate\": \"<string>\",\n \"status\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subType\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subclass\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"type\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n }\n },\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\"\n}"
response = http.request(request)
puts response.read_body{
"applicantId": "<string>",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"entity": {
"addresses": [
{
"addressId": "<string>",
"addressType": "<string>",
"buildingName": "<string>",
"careOf": "<string>",
"country": "<string>",
"endDate": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"longForm": "<string>",
"postalCode": "<string>",
"region": "<string>",
"startDate": "<string>",
"state": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"suburb": "<string>",
"town": "<string>",
"unitNumber": "<string>",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "<string>",
"dateOfBirth": "<string>",
"locality": "<string>",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "<string>"
},
"entityId": "<string>",
"entityProfile": "<string>",
"entityType": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "<string>",
"identityDocs": [
{
"country": "<string>",
"createdFromScan": true,
"docScan": [
{
"ScanDelete": true,
"scanCreated": "<string>",
"scanData": "<string>",
"scanDataRetrievalState": "<string>",
"scanDocId": "<string>",
"scanFilename": "<string>",
"scanMIME": "<string>",
"scanPageNum": 123,
"scanSide": "<string>",
"scanType": "<string>"
}
],
"documentId": "<string>",
"documentStatus": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"idExpiry": "<string>",
"idIssued": "<string>",
"idNumber": "<string>",
"idSubType": "<string>",
"idType": "<string>",
"manuallyModified": true,
"region": "<string>"
}
],
"name": {
"displayName": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"honourific": "<string>",
"middleName": "<string>"
},
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"blockingReasons": [
{
"candidates": [
{
"address": "<string>",
"code": "<string>",
"countryIso": "<string>",
"registeredName": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
],
"description": "<string>",
"type": "<string>"
}
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "<string>",
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"normalisedLegalStatus": "<string>",
"ownershipResolved": true,
"registeredName": "<string>",
"registration": {
"countryIso": "<string>",
"date": "<string>",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "<string>",
"endorsedTo": "<string>"
}
],
"gst": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "<string>",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "<string>",
"name": "<string>",
"registeredDate": "<string>",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "<string>"
}
},
"reviewDate": "<string>",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "<string>",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"provider": "OCRLabs",
"sms_sent": true,
"token": "41cf9401f0f889616bef",
"tokenExpiry": "<string>",
"vendorParameters": {
"tokenURL": "example1.com"
}
}{
"errorCode": "<string>",
"errorMsg": "<string>",
"issues": [
{
"issue": "<string>",
"issueLocation": "<string>"
}
],
"requestId": "<string>"
}API Reference
Retrieve a token to use with a check
Queries the IDV provider for a token to be used with their sdk
POST
/
idvalidate
/
token
Retrieve a token to use with a check
curl --request POST \
--url https://api.uat.frankie.one/idv/v2/idvalidate/token \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"consent": true,
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"entity": {
"addresses": [
{
"addressId": "<string>",
"addressType": "<string>",
"buildingName": "<string>",
"careOf": "<string>",
"country": "<string>",
"endDate": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"longForm": "<string>",
"postalCode": "<string>",
"region": "<string>",
"startDate": "<string>",
"state": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"suburb": "<string>",
"town": "<string>",
"unitNumber": "<string>",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "<string>",
"dateOfBirth": "<string>",
"locality": "<string>",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "<string>"
},
"entityId": "<string>",
"entityProfile": "<string>",
"entityType": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "<string>",
"identityDocs": [
{
"country": "<string>",
"createdFromScan": true,
"docScan": [
{
"ScanDelete": true,
"scanCreated": "<string>",
"scanData": "<string>",
"scanDataRetrievalState": "<string>",
"scanDocId": "<string>",
"scanFilename": "<string>",
"scanMIME": "<string>",
"scanPageNum": 123,
"scanSide": "<string>",
"scanType": "<string>"
}
],
"documentId": "<string>",
"documentStatus": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"idExpiry": "<string>",
"idIssued": "<string>",
"idNumber": "<string>",
"idSubType": "<string>",
"idType": "<string>",
"manuallyModified": true,
"region": "<string>"
}
],
"name": {
"displayName": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"honourific": "<string>",
"middleName": "<string>"
},
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"blockingReasons": [
{
"candidates": [
{
"address": "<string>",
"code": "<string>",
"countryIso": "<string>",
"registeredName": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
],
"description": "<string>",
"type": "<string>"
}
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "<string>",
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"normalisedLegalStatus": "<string>",
"ownershipResolved": true,
"registeredName": "<string>",
"registration": {
"countryIso": "<string>",
"date": "<string>",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "<string>",
"endorsedTo": "<string>"
}
],
"gst": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "<string>",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "<string>",
"name": "<string>",
"registeredDate": "<string>",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "<string>"
}
},
"reviewDate": "<string>",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "<string>",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5"
}
'import requests
url = "https://api.uat.frankie.one/idv/v2/idvalidate/token"
payload = {
"applicantId": "412e8c806fdfb0bb19b5",
"applicationId": "94d9a75a5072444c",
"consent": True,
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"entity": {
"addresses": [
{
"addressId": "<string>",
"addressType": "<string>",
"buildingName": "<string>",
"careOf": "<string>",
"country": "<string>",
"endDate": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"longForm": "<string>",
"postalCode": "<string>",
"region": "<string>",
"startDate": "<string>",
"state": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"suburb": "<string>",
"town": "<string>",
"unitNumber": "<string>",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "<string>",
"dateOfBirth": "<string>",
"locality": "<string>",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "<string>"
},
"entityId": "<string>",
"entityProfile": "<string>",
"entityType": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "<string>",
"identityDocs": [
{
"country": "<string>",
"createdFromScan": True,
"docScan": [
{
"ScanDelete": True,
"scanCreated": "<string>",
"scanData": "<string>",
"scanDataRetrievalState": "<string>",
"scanDocId": "<string>",
"scanFilename": "<string>",
"scanMIME": "<string>",
"scanPageNum": 123,
"scanSide": "<string>",
"scanType": "<string>"
}
],
"documentId": "<string>",
"documentStatus": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"idExpiry": "<string>",
"idIssued": "<string>",
"idNumber": "<string>",
"idSubType": "<string>",
"idType": "<string>",
"manuallyModified": True,
"region": "<string>"
}
],
"name": {
"displayName": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"honourific": "<string>",
"middleName": "<string>"
},
"organisationData": {
"adverseCreditDataPresent": True,
"aliases": ["<string>"],
"blockingReasons": [
{
"candidates": [
{
"address": "<string>",
"code": "<string>",
"countryIso": "<string>",
"registeredName": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
],
"description": "<string>",
"type": "<string>"
}
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": True,
"includesNonBeneficiallyHeld": True,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "<string>",
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"normalisedLegalStatus": "<string>",
"ownershipResolved": True,
"registeredName": "<string>",
"registration": {
"countryIso": "<string>",
"date": "<string>",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": { "abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "<string>",
"endorsedTo": "<string>"
}
],
"gst": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"historicalChanges": [
{
"businessName": ["<string>"],
"date": "<string>",
"entityStatus": ["<string>"],
"goodsAndServicesTax": ["<string>"],
"mainBusinessPhysicalAddress": ["<string>"],
"mainName": ["<string>"],
"mainTradingName": ["<string>"]
}
],
"lastUpdated": "<string>",
"name": "<string>",
"registeredDate": "<string>",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "<string>"
} },
"reviewDate": "<string>",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "<string>",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"referrer": "https://example.com",
"relayState": "412e8c806fdfb0bb19b5"
}
headers = {
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Frankie-CustomerID': '<x-frankie-customerid>',
api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
applicantId: '412e8c806fdfb0bb19b5',
applicationId: '94d9a75a5072444c',
consent: true,
country: 'AUS',
documentType: 'DRIVER_LICENCE',
entity: {
addresses: [
{
addressId: '<string>',
addressType: '<string>',
buildingName: '<string>',
careOf: '<string>',
country: '<string>',
endDate: '<string>',
extraData: [{kvpKey: '<string>', kvpType: '<string>', kvpValue: '<string>'}],
longForm: '<string>',
postalCode: '<string>',
region: '<string>',
startDate: '<string>',
state: '<string>',
streetName: '<string>',
streetNumber: '<string>',
streetType: '<string>',
suburb: '<string>',
town: '<string>',
unitNumber: '<string>',
unstructuredLongForm: '<string>'
}
],
dateOfBirth: {
country: '<string>',
dateOfBirth: '<string>',
locality: '<string>',
unstructuredDateOfBirth: '<string>',
yearOfBirth: '<string>'
},
entityId: '<string>',
entityProfile: '<string>',
entityType: '<string>',
extraData: [{kvpKey: '<string>', kvpType: '<string>', kvpValue: '<string>'}],
flags: [{flag: '<string>', value: 123}],
gender: '<string>',
identityDocs: [
{
country: '<string>',
createdFromScan: true,
docScan: [
{
ScanDelete: true,
scanCreated: '<string>',
scanData: '<string>',
scanDataRetrievalState: '<string>',
scanDocId: '<string>',
scanFilename: '<string>',
scanMIME: '<string>',
scanPageNum: 123,
scanSide: '<string>',
scanType: '<string>'
}
],
documentId: '<string>',
documentStatus: '<string>',
extraData: [{kvpKey: '<string>', kvpType: '<string>', kvpValue: '<string>'}],
idExpiry: '<string>',
idIssued: '<string>',
idNumber: '<string>',
idSubType: '<string>',
idType: '<string>',
manuallyModified: true,
region: '<string>'
}
],
name: {
displayName: '<string>',
familyName: '<string>',
givenName: '<string>',
honourific: '<string>',
middleName: '<string>'
},
organisationData: {
adverseCreditDataPresent: true,
aliases: ['<string>'],
blockingReasons: [
{
candidates: [
{
address: '<string>',
code: '<string>',
countryIso: '<string>',
registeredName: '<string>',
registryDescription: '<string>',
subdivision: '<string>'
}
],
description: '<string>',
type: '<string>'
}
],
class: {code: '<string>', description: '<string>'},
contactDetails: {
email: '<string>',
faxNumber: '<string>',
telephoneNumber: '<string>',
websiteURL: '<string>'
},
disclosingEntityIndicator: true,
includesNonBeneficiallyHeld: true,
industryCodes: [{code: '<string>', description: '<string>'}],
industryDeclarations: [{description: '<string>', language: '<string>'}],
kycCustomerType: '<string>',
lastCheckDate: '<string>',
legalFormDetails: {
basis: '<string>',
capital: '<string>',
comments: '<string>',
control: '<string>',
incorp: '<string>',
partner: '<string>',
responsibility: '<string>',
stocks: '<string>'
},
normalisedLegalStatus: '<string>',
ownershipResolved: true,
registeredName: '<string>',
registration: {
countryIso: '<string>',
date: '<string>',
number: '<string>',
previousNumber: '<string>',
registryCode: '<string>',
registryDescription: '<string>',
state: '<string>',
unstructuredDate: '<string>',
unstructuredFoundationDate: '<string>'
},
registries: {
abr: {
abn: '<string>',
acn: '<string>',
addresses: [
{
effectiveFrom: '<string>',
effectiveTo: '<string>',
postcode: '<string>',
stateCode: '<string>'
}
],
businessNames: [
{
effectiveFrom: '<string>',
effectiveTo: '<string>',
name: '<string>',
type: '<string>'
}
],
charityEndorsements: [{effectiveFrom: '<string>', effectiveTo: '<string>', type: '<string>'}],
charityTypes: [{description: '<string>', effectiveFrom: '<string>', effectiveTo: '<string>'}],
description: '<string>',
dgrEndorsements: [{endorsedFrom: '<string>', endorsedTo: '<string>'}],
gst: [{effectiveFrom: '<string>', effectiveTo: '<string>'}],
historicalChanges: [
{
businessName: ['<string>'],
date: '<string>',
entityStatus: ['<string>'],
goodsAndServicesTax: ['<string>'],
mainBusinessPhysicalAddress: ['<string>'],
mainName: ['<string>'],
mainTradingName: ['<string>']
}
],
lastUpdated: '<string>',
name: '<string>',
registeredDate: '<string>',
status: '<string>',
statusEffectiveFrom: '<string>',
type: '<string>',
typeCode: '<string>',
updatedDate: '<string>'
}
},
reviewDate: '<string>',
shareStructure: [
{
amountDue: 123,
amountPaid: 123,
classCode: '<string>',
classTitle: '<string>',
docNumber: '<string>',
docNumberQualifier: '<string>',
sharesIssued: 123,
status: '<string>'
}
],
startDate: '<string>',
status: {code: '<string>', description: '<string>'},
subType: {code: '<string>', description: '<string>'},
subclass: {code: '<string>', description: '<string>'},
type: {code: '<string>', description: '<string>'}
}
},
referrer: 'https://example.com',
relayState: '412e8c806fdfb0bb19b5'
})
};
fetch('https://api.uat.frankie.one/idv/v2/idvalidate/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/idv/v2/idvalidate/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',
'consent' => true,
'country' => 'AUS',
'documentType' => 'DRIVER_LICENCE',
'entity' => [
'addresses' => [
[
'addressId' => '<string>',
'addressType' => '<string>',
'buildingName' => '<string>',
'careOf' => '<string>',
'country' => '<string>',
'endDate' => '<string>',
'extraData' => [
[
'kvpKey' => '<string>',
'kvpType' => '<string>',
'kvpValue' => '<string>'
]
],
'longForm' => '<string>',
'postalCode' => '<string>',
'region' => '<string>',
'startDate' => '<string>',
'state' => '<string>',
'streetName' => '<string>',
'streetNumber' => '<string>',
'streetType' => '<string>',
'suburb' => '<string>',
'town' => '<string>',
'unitNumber' => '<string>',
'unstructuredLongForm' => '<string>'
]
],
'dateOfBirth' => [
'country' => '<string>',
'dateOfBirth' => '<string>',
'locality' => '<string>',
'unstructuredDateOfBirth' => '<string>',
'yearOfBirth' => '<string>'
],
'entityId' => '<string>',
'entityProfile' => '<string>',
'entityType' => '<string>',
'extraData' => [
[
'kvpKey' => '<string>',
'kvpType' => '<string>',
'kvpValue' => '<string>'
]
],
'flags' => [
[
'flag' => '<string>',
'value' => 123
]
],
'gender' => '<string>',
'identityDocs' => [
[
'country' => '<string>',
'createdFromScan' => true,
'docScan' => [
[
'ScanDelete' => true,
'scanCreated' => '<string>',
'scanData' => '<string>',
'scanDataRetrievalState' => '<string>',
'scanDocId' => '<string>',
'scanFilename' => '<string>',
'scanMIME' => '<string>',
'scanPageNum' => 123,
'scanSide' => '<string>',
'scanType' => '<string>'
]
],
'documentId' => '<string>',
'documentStatus' => '<string>',
'extraData' => [
[
'kvpKey' => '<string>',
'kvpType' => '<string>',
'kvpValue' => '<string>'
]
],
'idExpiry' => '<string>',
'idIssued' => '<string>',
'idNumber' => '<string>',
'idSubType' => '<string>',
'idType' => '<string>',
'manuallyModified' => true,
'region' => '<string>'
]
],
'name' => [
'displayName' => '<string>',
'familyName' => '<string>',
'givenName' => '<string>',
'honourific' => '<string>',
'middleName' => '<string>'
],
'organisationData' => [
'adverseCreditDataPresent' => true,
'aliases' => [
'<string>'
],
'blockingReasons' => [
[
'candidates' => [
[
'address' => '<string>',
'code' => '<string>',
'countryIso' => '<string>',
'registeredName' => '<string>',
'registryDescription' => '<string>',
'subdivision' => '<string>'
]
],
'description' => '<string>',
'type' => '<string>'
]
],
'class' => [
'code' => '<string>',
'description' => '<string>'
],
'contactDetails' => [
'email' => '<string>',
'faxNumber' => '<string>',
'telephoneNumber' => '<string>',
'websiteURL' => '<string>'
],
'disclosingEntityIndicator' => true,
'includesNonBeneficiallyHeld' => true,
'industryCodes' => [
[
'code' => '<string>',
'description' => '<string>'
]
],
'industryDeclarations' => [
[
'description' => '<string>',
'language' => '<string>'
]
],
'kycCustomerType' => '<string>',
'lastCheckDate' => '<string>',
'legalFormDetails' => [
'basis' => '<string>',
'capital' => '<string>',
'comments' => '<string>',
'control' => '<string>',
'incorp' => '<string>',
'partner' => '<string>',
'responsibility' => '<string>',
'stocks' => '<string>'
],
'normalisedLegalStatus' => '<string>',
'ownershipResolved' => true,
'registeredName' => '<string>',
'registration' => [
'countryIso' => '<string>',
'date' => '<string>',
'number' => '<string>',
'previousNumber' => '<string>',
'registryCode' => '<string>',
'registryDescription' => '<string>',
'state' => '<string>',
'unstructuredDate' => '<string>',
'unstructuredFoundationDate' => '<string>'
],
'registries' => [
'abr' => [
'abn' => '<string>',
'acn' => '<string>',
'addresses' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>',
'postcode' => '<string>',
'stateCode' => '<string>'
]
],
'businessNames' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>',
'name' => '<string>',
'type' => '<string>'
]
],
'charityEndorsements' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>',
'type' => '<string>'
]
],
'charityTypes' => [
[
'description' => '<string>',
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>'
]
],
'description' => '<string>',
'dgrEndorsements' => [
[
'endorsedFrom' => '<string>',
'endorsedTo' => '<string>'
]
],
'gst' => [
[
'effectiveFrom' => '<string>',
'effectiveTo' => '<string>'
]
],
'historicalChanges' => [
[
'businessName' => [
'<string>'
],
'date' => '<string>',
'entityStatus' => [
'<string>'
],
'goodsAndServicesTax' => [
'<string>'
],
'mainBusinessPhysicalAddress' => [
'<string>'
],
'mainName' => [
'<string>'
],
'mainTradingName' => [
'<string>'
]
]
],
'lastUpdated' => '<string>',
'name' => '<string>',
'registeredDate' => '<string>',
'status' => '<string>',
'statusEffectiveFrom' => '<string>',
'type' => '<string>',
'typeCode' => '<string>',
'updatedDate' => '<string>'
]
],
'reviewDate' => '<string>',
'shareStructure' => [
[
'amountDue' => 123,
'amountPaid' => 123,
'classCode' => '<string>',
'classTitle' => '<string>',
'docNumber' => '<string>',
'docNumberQualifier' => '<string>',
'sharesIssued' => 123,
'status' => '<string>'
]
],
'startDate' => '<string>',
'status' => [
'code' => '<string>',
'description' => '<string>'
],
'subType' => [
'code' => '<string>',
'description' => '<string>'
],
'subclass' => [
'code' => '<string>',
'description' => '<string>'
],
'type' => [
'code' => '<string>',
'description' => '<string>'
]
]
],
'referrer' => 'https://example.com',
'relayState' => '412e8c806fdfb0bb19b5'
]),
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/idv/v2/idvalidate/token"
payload := strings.NewReader("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"consent\": true,\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"entity\": {\n \"addresses\": [\n {\n \"addressId\": \"<string>\",\n \"addressType\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"careOf\": \"<string>\",\n \"country\": \"<string>\",\n \"endDate\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"longForm\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"startDate\": \"<string>\",\n \"state\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"suburb\": \"<string>\",\n \"town\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"locality\": \"<string>\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"<string>\"\n },\n \"entityId\": \"<string>\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"<string>\",\n \"identityDocs\": [\n {\n \"country\": \"<string>\",\n \"createdFromScan\": true,\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"<string>\",\n \"scanData\": \"<string>\",\n \"scanDataRetrievalState\": \"<string>\",\n \"scanDocId\": \"<string>\",\n \"scanFilename\": \"<string>\",\n \"scanMIME\": \"<string>\",\n \"scanPageNum\": 123,\n \"scanSide\": \"<string>\",\n \"scanType\": \"<string>\"\n }\n ],\n \"documentId\": \"<string>\",\n \"documentStatus\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"idExpiry\": \"<string>\",\n \"idIssued\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"idSubType\": \"<string>\",\n \"idType\": \"<string>\",\n \"manuallyModified\": true,\n \"region\": \"<string>\"\n }\n ],\n \"name\": {\n \"displayName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"honourific\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\n ],\n \"blockingReasons\": [\n {\n \"candidates\": [\n {\n \"address\": \"<string>\",\n \"code\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"registeredName\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"subdivision\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"class\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"contactDetails\": {\n \"email\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"telephoneNumber\": \"<string>\",\n \"websiteURL\": \"<string>\"\n },\n \"disclosingEntityIndicator\": true,\n \"includesNonBeneficiallyHeld\": true,\n \"industryCodes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"industryDeclarations\": [\n {\n \"description\": \"<string>\",\n \"language\": \"<string>\"\n }\n ],\n \"kycCustomerType\": \"<string>\",\n \"lastCheckDate\": \"<string>\",\n \"legalFormDetails\": {\n \"basis\": \"<string>\",\n \"capital\": \"<string>\",\n \"comments\": \"<string>\",\n \"control\": \"<string>\",\n \"incorp\": \"<string>\",\n \"partner\": \"<string>\",\n \"responsibility\": \"<string>\",\n \"stocks\": \"<string>\"\n },\n \"normalisedLegalStatus\": \"<string>\",\n \"ownershipResolved\": true,\n \"registeredName\": \"<string>\",\n \"registration\": {\n \"countryIso\": \"<string>\",\n \"date\": \"<string>\",\n \"number\": \"<string>\",\n \"previousNumber\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"state\": \"<string>\",\n \"unstructuredDate\": \"<string>\",\n \"unstructuredFoundationDate\": \"<string>\"\n },\n \"registries\": {\n \"abr\": {\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"addresses\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"<string>\",\n \"endorsedTo\": \"<string>\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"<string>\",\n \"entityStatus\": [\n \"<string>\"\n ],\n \"goodsAndServicesTax\": [\n \"<string>\"\n ],\n \"mainBusinessPhysicalAddress\": [\n \"<string>\"\n ],\n \"mainName\": [\n \"<string>\"\n ],\n \"mainTradingName\": [\n \"<string>\"\n ]\n }\n ],\n \"lastUpdated\": \"<string>\",\n \"name\": \"<string>\",\n \"registeredDate\": \"<string>\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"<string>\"\n }\n },\n \"reviewDate\": \"<string>\",\n \"shareStructure\": [\n {\n \"amountDue\": 123,\n \"amountPaid\": 123,\n \"classCode\": \"<string>\",\n \"classTitle\": \"<string>\",\n \"docNumber\": \"<string>\",\n \"docNumberQualifier\": \"<string>\",\n \"sharesIssued\": 123,\n \"status\": \"<string>\"\n }\n ],\n \"startDate\": \"<string>\",\n \"status\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subType\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subclass\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"type\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n }\n },\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("api_key", "<api-key>")
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/idv/v2/idvalidate/token")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"consent\": true,\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"entity\": {\n \"addresses\": [\n {\n \"addressId\": \"<string>\",\n \"addressType\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"careOf\": \"<string>\",\n \"country\": \"<string>\",\n \"endDate\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"longForm\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"startDate\": \"<string>\",\n \"state\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"suburb\": \"<string>\",\n \"town\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"locality\": \"<string>\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"<string>\"\n },\n \"entityId\": \"<string>\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"<string>\",\n \"identityDocs\": [\n {\n \"country\": \"<string>\",\n \"createdFromScan\": true,\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"<string>\",\n \"scanData\": \"<string>\",\n \"scanDataRetrievalState\": \"<string>\",\n \"scanDocId\": \"<string>\",\n \"scanFilename\": \"<string>\",\n \"scanMIME\": \"<string>\",\n \"scanPageNum\": 123,\n \"scanSide\": \"<string>\",\n \"scanType\": \"<string>\"\n }\n ],\n \"documentId\": \"<string>\",\n \"documentStatus\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"idExpiry\": \"<string>\",\n \"idIssued\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"idSubType\": \"<string>\",\n \"idType\": \"<string>\",\n \"manuallyModified\": true,\n \"region\": \"<string>\"\n }\n ],\n \"name\": {\n \"displayName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"honourific\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\n ],\n \"blockingReasons\": [\n {\n \"candidates\": [\n {\n \"address\": \"<string>\",\n \"code\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"registeredName\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"subdivision\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"class\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"contactDetails\": {\n \"email\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"telephoneNumber\": \"<string>\",\n \"websiteURL\": \"<string>\"\n },\n \"disclosingEntityIndicator\": true,\n \"includesNonBeneficiallyHeld\": true,\n \"industryCodes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"industryDeclarations\": [\n {\n \"description\": \"<string>\",\n \"language\": \"<string>\"\n }\n ],\n \"kycCustomerType\": \"<string>\",\n \"lastCheckDate\": \"<string>\",\n \"legalFormDetails\": {\n \"basis\": \"<string>\",\n \"capital\": \"<string>\",\n \"comments\": \"<string>\",\n \"control\": \"<string>\",\n \"incorp\": \"<string>\",\n \"partner\": \"<string>\",\n \"responsibility\": \"<string>\",\n \"stocks\": \"<string>\"\n },\n \"normalisedLegalStatus\": \"<string>\",\n \"ownershipResolved\": true,\n \"registeredName\": \"<string>\",\n \"registration\": {\n \"countryIso\": \"<string>\",\n \"date\": \"<string>\",\n \"number\": \"<string>\",\n \"previousNumber\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"state\": \"<string>\",\n \"unstructuredDate\": \"<string>\",\n \"unstructuredFoundationDate\": \"<string>\"\n },\n \"registries\": {\n \"abr\": {\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"addresses\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"<string>\",\n \"endorsedTo\": \"<string>\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"<string>\",\n \"entityStatus\": [\n \"<string>\"\n ],\n \"goodsAndServicesTax\": [\n \"<string>\"\n ],\n \"mainBusinessPhysicalAddress\": [\n \"<string>\"\n ],\n \"mainName\": [\n \"<string>\"\n ],\n \"mainTradingName\": [\n \"<string>\"\n ]\n }\n ],\n \"lastUpdated\": \"<string>\",\n \"name\": \"<string>\",\n \"registeredDate\": \"<string>\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"<string>\"\n }\n },\n \"reviewDate\": \"<string>\",\n \"shareStructure\": [\n {\n \"amountDue\": 123,\n \"amountPaid\": 123,\n \"classCode\": \"<string>\",\n \"classTitle\": \"<string>\",\n \"docNumber\": \"<string>\",\n \"docNumberQualifier\": \"<string>\",\n \"sharesIssued\": 123,\n \"status\": \"<string>\"\n }\n ],\n \"startDate\": \"<string>\",\n \"status\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subType\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subclass\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"type\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n }\n },\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/idv/v2/idvalidate/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applicantId\": \"412e8c806fdfb0bb19b5\",\n \"applicationId\": \"94d9a75a5072444c\",\n \"consent\": true,\n \"country\": \"AUS\",\n \"documentType\": \"DRIVER_LICENCE\",\n \"entity\": {\n \"addresses\": [\n {\n \"addressId\": \"<string>\",\n \"addressType\": \"<string>\",\n \"buildingName\": \"<string>\",\n \"careOf\": \"<string>\",\n \"country\": \"<string>\",\n \"endDate\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"longForm\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"region\": \"<string>\",\n \"startDate\": \"<string>\",\n \"state\": \"<string>\",\n \"streetName\": \"<string>\",\n \"streetNumber\": \"<string>\",\n \"streetType\": \"<string>\",\n \"suburb\": \"<string>\",\n \"town\": \"<string>\",\n \"unitNumber\": \"<string>\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"<string>\",\n \"dateOfBirth\": \"<string>\",\n \"locality\": \"<string>\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"<string>\"\n },\n \"entityId\": \"<string>\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"<string>\",\n \"identityDocs\": [\n {\n \"country\": \"<string>\",\n \"createdFromScan\": true,\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"<string>\",\n \"scanData\": \"<string>\",\n \"scanDataRetrievalState\": \"<string>\",\n \"scanDocId\": \"<string>\",\n \"scanFilename\": \"<string>\",\n \"scanMIME\": \"<string>\",\n \"scanPageNum\": 123,\n \"scanSide\": \"<string>\",\n \"scanType\": \"<string>\"\n }\n ],\n \"documentId\": \"<string>\",\n \"documentStatus\": \"<string>\",\n \"extraData\": [\n {\n \"kvpKey\": \"<string>\",\n \"kvpType\": \"<string>\",\n \"kvpValue\": \"<string>\"\n }\n ],\n \"idExpiry\": \"<string>\",\n \"idIssued\": \"<string>\",\n \"idNumber\": \"<string>\",\n \"idSubType\": \"<string>\",\n \"idType\": \"<string>\",\n \"manuallyModified\": true,\n \"region\": \"<string>\"\n }\n ],\n \"name\": {\n \"displayName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"givenName\": \"<string>\",\n \"honourific\": \"<string>\",\n \"middleName\": \"<string>\"\n },\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\n ],\n \"blockingReasons\": [\n {\n \"candidates\": [\n {\n \"address\": \"<string>\",\n \"code\": \"<string>\",\n \"countryIso\": \"<string>\",\n \"registeredName\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"subdivision\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"class\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"contactDetails\": {\n \"email\": \"<string>\",\n \"faxNumber\": \"<string>\",\n \"telephoneNumber\": \"<string>\",\n \"websiteURL\": \"<string>\"\n },\n \"disclosingEntityIndicator\": true,\n \"includesNonBeneficiallyHeld\": true,\n \"industryCodes\": [\n {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"industryDeclarations\": [\n {\n \"description\": \"<string>\",\n \"language\": \"<string>\"\n }\n ],\n \"kycCustomerType\": \"<string>\",\n \"lastCheckDate\": \"<string>\",\n \"legalFormDetails\": {\n \"basis\": \"<string>\",\n \"capital\": \"<string>\",\n \"comments\": \"<string>\",\n \"control\": \"<string>\",\n \"incorp\": \"<string>\",\n \"partner\": \"<string>\",\n \"responsibility\": \"<string>\",\n \"stocks\": \"<string>\"\n },\n \"normalisedLegalStatus\": \"<string>\",\n \"ownershipResolved\": true,\n \"registeredName\": \"<string>\",\n \"registration\": {\n \"countryIso\": \"<string>\",\n \"date\": \"<string>\",\n \"number\": \"<string>\",\n \"previousNumber\": \"<string>\",\n \"registryCode\": \"<string>\",\n \"registryDescription\": \"<string>\",\n \"state\": \"<string>\",\n \"unstructuredDate\": \"<string>\",\n \"unstructuredFoundationDate\": \"<string>\"\n },\n \"registries\": {\n \"abr\": {\n \"abn\": \"<string>\",\n \"acn\": \"<string>\",\n \"addresses\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"<string>\",\n \"endorsedTo\": \"<string>\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"<string>\",\n \"effectiveTo\": \"<string>\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"<string>\",\n \"entityStatus\": [\n \"<string>\"\n ],\n \"goodsAndServicesTax\": [\n \"<string>\"\n ],\n \"mainBusinessPhysicalAddress\": [\n \"<string>\"\n ],\n \"mainName\": [\n \"<string>\"\n ],\n \"mainTradingName\": [\n \"<string>\"\n ]\n }\n ],\n \"lastUpdated\": \"<string>\",\n \"name\": \"<string>\",\n \"registeredDate\": \"<string>\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"<string>\"\n }\n },\n \"reviewDate\": \"<string>\",\n \"shareStructure\": [\n {\n \"amountDue\": 123,\n \"amountPaid\": 123,\n \"classCode\": \"<string>\",\n \"classTitle\": \"<string>\",\n \"docNumber\": \"<string>\",\n \"docNumberQualifier\": \"<string>\",\n \"sharesIssued\": 123,\n \"status\": \"<string>\"\n }\n ],\n \"startDate\": \"<string>\",\n \"status\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subType\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"subclass\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n },\n \"type\": {\n \"code\": \"<string>\",\n \"description\": \"<string>\"\n }\n }\n },\n \"referrer\": \"https://example.com\",\n \"relayState\": \"412e8c806fdfb0bb19b5\"\n}"
response = http.request(request)
puts response.read_body{
"applicantId": "<string>",
"country": "AUS",
"documentType": "DRIVER_LICENCE",
"entity": {
"addresses": [
{
"addressId": "<string>",
"addressType": "<string>",
"buildingName": "<string>",
"careOf": "<string>",
"country": "<string>",
"endDate": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"longForm": "<string>",
"postalCode": "<string>",
"region": "<string>",
"startDate": "<string>",
"state": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"suburb": "<string>",
"town": "<string>",
"unitNumber": "<string>",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "<string>",
"dateOfBirth": "<string>",
"locality": "<string>",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "<string>"
},
"entityId": "<string>",
"entityProfile": "<string>",
"entityType": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "<string>",
"identityDocs": [
{
"country": "<string>",
"createdFromScan": true,
"docScan": [
{
"ScanDelete": true,
"scanCreated": "<string>",
"scanData": "<string>",
"scanDataRetrievalState": "<string>",
"scanDocId": "<string>",
"scanFilename": "<string>",
"scanMIME": "<string>",
"scanPageNum": 123,
"scanSide": "<string>",
"scanType": "<string>"
}
],
"documentId": "<string>",
"documentStatus": "<string>",
"extraData": [
{
"kvpKey": "<string>",
"kvpType": "<string>",
"kvpValue": "<string>"
}
],
"idExpiry": "<string>",
"idIssued": "<string>",
"idNumber": "<string>",
"idSubType": "<string>",
"idType": "<string>",
"manuallyModified": true,
"region": "<string>"
}
],
"name": {
"displayName": "<string>",
"familyName": "<string>",
"givenName": "<string>",
"honourific": "<string>",
"middleName": "<string>"
},
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"blockingReasons": [
{
"candidates": [
{
"address": "<string>",
"code": "<string>",
"countryIso": "<string>",
"registeredName": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
],
"description": "<string>",
"type": "<string>"
}
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "<string>",
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>"
},
"normalisedLegalStatus": "<string>",
"ownershipResolved": true,
"registeredName": "<string>",
"registration": {
"countryIso": "<string>",
"date": "<string>",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "<string>",
"endorsedTo": "<string>"
}
],
"gst": [
{
"effectiveFrom": "<string>",
"effectiveTo": "<string>"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "<string>",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "<string>",
"name": "<string>",
"registeredDate": "<string>",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "<string>"
}
},
"reviewDate": "<string>",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "<string>",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"provider": "OCRLabs",
"sms_sent": true,
"token": "41cf9401f0f889616bef",
"tokenExpiry": "<string>",
"vendorParameters": {
"tokenURL": "example1.com"
}
}{
"errorCode": "<string>",
"errorMsg": "<string>",
"issues": [
{
"issue": "<string>",
"issueLocation": "<string>"
}
],
"requestId": "<string>"
}Authorizations
API key issued by FrankieOne. This will rotate regularly
Headers
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time
If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children
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
Details required to fetch a token from the IDV provider
ID of the applicant/individual in the IDV provider's system. Specify this if resuming/continuing an IDV check
Example:
"412e8c806fdfb0bb19b5"
ID of the application/check in the IDV provider's system. Specify this if resuming/continuing an IDV check
Example:
"94d9a75a5072444c"
Has user consented. If not supplied or is false, consent will need to be submitted via provider SDK
Example:
true
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. Can be one of DRIVERS_LICENCE, PASSPORT, NATIONAL_ID
Example:
"DRIVER_LICENCE"
Show child attributes
Show child attributes
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"
Response
OK
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"
Show child attributes
Show child attributes
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
Show child attributes
Show child attributes
Example:
{ "tokenURL": "example1.com" }
Was this page helpful?
⌘I