Update Entity and Initiate IDV Process
curl --request POST \
--url https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"entity": {
"addresses": [
{
"country": "AUS",
"addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
"addressType": "REGISTERED_OFFICE",
"buildingName": "Highland Tower",
"careOf": "<string>",
"endDate": "0001-01-01",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "3000",
"region": "MELBOURNE",
"startDate": "2023-03-10",
"state": "VIC",
"streetName": "9 ROYCE AVENUE",
"streetNumber": "FLAT 27",
"streetType": "Road",
"suburb": "Testburb",
"town": "MELBOURNE",
"unitNumber": "FLAT 27",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "1978"
},
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "<string>",
"entityType": "ORGANISATION",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "F",
"identityDocs": [
{
"country": "AUS",
"idType": "DRIVERS_LICENCE",
"docScan": [
{
"ScanDelete": true,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "image/png",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "<string>",
"region": "VIC"
}
],
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"extractedDate": "2023-12-25",
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "2023-12-25",
"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": "2023-12-25",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "2023-11-07T05:31:56Z",
"endorsedTo": "2023-11-07T05:31:56Z"
}
],
"gst": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "2023-11-07T05:31:56Z",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"registeredDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
},
"reviewDate": "2023-12-25",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "2023-12-25",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"deviceCheckDetails": {
"activityType": "<string>",
"additionalData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"checkSessionKey": "<string>"
}
}
'import requests
url = "https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess"
payload = {
"entity": {
"addresses": [
{
"country": "AUS",
"addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
"addressType": "REGISTERED_OFFICE",
"buildingName": "Highland Tower",
"careOf": "<string>",
"endDate": "0001-01-01",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "3000",
"region": "MELBOURNE",
"startDate": "2023-03-10",
"state": "VIC",
"streetName": "9 ROYCE AVENUE",
"streetNumber": "FLAT 27",
"streetType": "Road",
"suburb": "Testburb",
"town": "MELBOURNE",
"unitNumber": "FLAT 27",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "1978"
},
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "<string>",
"entityType": "ORGANISATION",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "F",
"identityDocs": [
{
"country": "AUS",
"idType": "DRIVERS_LICENCE",
"docScan": [
{
"ScanDelete": True,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "image/png",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "<string>",
"region": "VIC"
}
],
"organisationData": {
"adverseCreditDataPresent": True,
"aliases": ["<string>"],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": True,
"extractedDate": "2023-12-25",
"includesNonBeneficiallyHeld": True,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "2023-12-25",
"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": "2023-12-25",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": { "abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "2023-11-07T05:31:56Z",
"endorsedTo": "2023-11-07T05:31:56Z"
}
],
"gst": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"historicalChanges": [
{
"businessName": ["<string>"],
"date": "2023-11-07T05:31:56Z",
"entityStatus": ["<string>"],
"goodsAndServicesTax": ["<string>"],
"mainBusinessPhysicalAddress": ["<string>"],
"mainName": ["<string>"],
"mainTradingName": ["<string>"]
}
],
"lastUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"registeredDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
} },
"reviewDate": "2023-12-25",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "2023-12-25",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"deviceCheckDetails": {
"activityType": "<string>",
"additionalData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"checkSessionKey": "<string>"
}
}
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({
entity: {
addresses: [
{
country: 'AUS',
addressId: '86932629-bdb4-158f-e670-741e89ff78ba',
addressType: 'REGISTERED_OFFICE',
buildingName: 'Highland Tower',
careOf: '<string>',
endDate: '0001-01-01',
extraData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
longForm: '42a Test Eagle Road, Testville, TST 123-TST, Testalia',
postalCode: '3000',
region: 'MELBOURNE',
startDate: '2023-03-10',
state: 'VIC',
streetName: '9 ROYCE AVENUE',
streetNumber: 'FLAT 27',
streetType: 'Road',
suburb: 'Testburb',
town: 'MELBOURNE',
unitNumber: 'FLAT 27',
unstructuredLongForm: '<string>'
}
],
dateOfBirth: {
country: 'AUS',
dateOfBirth: '1978-11-12',
locality: 'Brisbane',
unstructuredDateOfBirth: '<string>',
yearOfBirth: '1978'
},
entityId: '84a9a860-68ae-4d7d-9a53-54a1116d5051',
entityProfile: '<string>',
entityType: 'ORGANISATION',
extraData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
flags: [{flag: '<string>', value: 123}],
gender: 'F',
identityDocs: [
{
country: 'AUS',
idType: 'DRIVERS_LICENCE',
docScan: [
{
ScanDelete: true,
scanCreated: '2020-06-02',
scanData: 'VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==',
scanDataRetrievalState: 'NORMAL',
scanDocId: '84a9a860-68ae-4d7d-9a53-54a1116d5051',
scanFilename: 'Important Document - ID1234567.pdf',
scanMIME: 'image/png',
scanPageNum: 1,
scanSide: 'F',
scanType: 'PDF'
}
],
documentId: '84a9a860-68ae-4d7d-9a53-54a1116d5051',
documentStatus: 'DOC_SCANNED',
extraData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
idExpiry: '2020-02-01',
idIssued: '1972-11-04',
idNumber: '123456789',
idSubType: '<string>',
region: 'VIC'
}
],
organisationData: {
adverseCreditDataPresent: true,
aliases: ['<string>'],
class: {code: '<string>', description: '<string>'},
contactDetails: {
email: '<string>',
faxNumber: '<string>',
telephoneNumber: '<string>',
websiteURL: '<string>'
},
disclosingEntityIndicator: true,
extractedDate: '2023-12-25',
includesNonBeneficiallyHeld: true,
industryCodes: [{code: '<string>', description: '<string>'}],
industryDeclarations: [{description: '<string>', language: '<string>'}],
kycCustomerType: '<string>',
lastCheckDate: '2023-12-25',
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: '2023-12-25',
number: '<string>',
previousNumber: '<string>',
registryCode: '<string>',
registryDescription: '<string>',
state: '<string>',
unstructuredDate: '<string>',
unstructuredFoundationDate: '<string>'
},
registries: {
abr: {
abn: '<string>',
acn: '<string>',
addresses: [
{
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z',
postcode: '<string>',
stateCode: '<string>'
}
],
businessNames: [
{
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z',
name: '<string>',
type: '<string>'
}
],
charityEndorsements: [
{
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z',
type: '<string>'
}
],
charityTypes: [
{
description: '<string>',
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z'
}
],
description: '<string>',
dgrEndorsements: [{endorsedFrom: '2023-11-07T05:31:56Z', endorsedTo: '2023-11-07T05:31:56Z'}],
gst: [{effectiveFrom: '2023-11-07T05:31:56Z', effectiveTo: '2023-11-07T05:31:56Z'}],
historicalChanges: [
{
businessName: ['<string>'],
date: '2023-11-07T05:31:56Z',
entityStatus: ['<string>'],
goodsAndServicesTax: ['<string>'],
mainBusinessPhysicalAddress: ['<string>'],
mainName: ['<string>'],
mainTradingName: ['<string>']
}
],
lastUpdated: '2023-11-07T05:31:56Z',
name: '<string>',
registeredDate: '2023-11-07T05:31:56Z',
status: '<string>',
statusEffectiveFrom: '<string>',
type: '<string>',
typeCode: '<string>',
updatedDate: '2023-11-07T05:31:56Z'
}
},
reviewDate: '2023-12-25',
shareStructure: [
{
amountDue: 123,
amountPaid: 123,
classCode: '<string>',
classTitle: '<string>',
docNumber: '<string>',
docNumberQualifier: '<string>',
sharesIssued: 123,
status: '<string>'
}
],
startDate: '2023-12-25',
status: {code: '<string>', description: '<string>'},
subType: {code: '<string>', description: '<string>'},
subclass: {code: '<string>', description: '<string>'},
type: {code: '<string>', description: '<string>'}
}
},
deviceCheckDetails: {
activityType: '<string>',
additionalData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
checkSessionKey: '<string>'
}
})
};
fetch('https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess', 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/compliance/v1.2/entity/{entityId}/idvalidate/initProcess",
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([
'entity' => [
'addresses' => [
[
'country' => 'AUS',
'addressId' => '86932629-bdb4-158f-e670-741e89ff78ba',
'addressType' => 'REGISTERED_OFFICE',
'buildingName' => 'Highland Tower',
'careOf' => '<string>',
'endDate' => '0001-01-01',
'extraData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'longForm' => '42a Test Eagle Road, Testville, TST 123-TST, Testalia',
'postalCode' => '3000',
'region' => 'MELBOURNE',
'startDate' => '2023-03-10',
'state' => 'VIC',
'streetName' => '9 ROYCE AVENUE',
'streetNumber' => 'FLAT 27',
'streetType' => 'Road',
'suburb' => 'Testburb',
'town' => 'MELBOURNE',
'unitNumber' => 'FLAT 27',
'unstructuredLongForm' => '<string>'
]
],
'dateOfBirth' => [
'country' => 'AUS',
'dateOfBirth' => '1978-11-12',
'locality' => 'Brisbane',
'unstructuredDateOfBirth' => '<string>',
'yearOfBirth' => '1978'
],
'entityId' => '84a9a860-68ae-4d7d-9a53-54a1116d5051',
'entityProfile' => '<string>',
'entityType' => 'ORGANISATION',
'extraData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'flags' => [
[
'flag' => '<string>',
'value' => 123
]
],
'gender' => 'F',
'identityDocs' => [
[
'country' => 'AUS',
'idType' => 'DRIVERS_LICENCE',
'docScan' => [
[
'ScanDelete' => true,
'scanCreated' => '2020-06-02',
'scanData' => 'VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==',
'scanDataRetrievalState' => 'NORMAL',
'scanDocId' => '84a9a860-68ae-4d7d-9a53-54a1116d5051',
'scanFilename' => 'Important Document - ID1234567.pdf',
'scanMIME' => 'image/png',
'scanPageNum' => 1,
'scanSide' => 'F',
'scanType' => 'PDF'
]
],
'documentId' => '84a9a860-68ae-4d7d-9a53-54a1116d5051',
'documentStatus' => 'DOC_SCANNED',
'extraData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'idExpiry' => '2020-02-01',
'idIssued' => '1972-11-04',
'idNumber' => '123456789',
'idSubType' => '<string>',
'region' => 'VIC'
]
],
'organisationData' => [
'adverseCreditDataPresent' => true,
'aliases' => [
'<string>'
],
'class' => [
'code' => '<string>',
'description' => '<string>'
],
'contactDetails' => [
'email' => '<string>',
'faxNumber' => '<string>',
'telephoneNumber' => '<string>',
'websiteURL' => '<string>'
],
'disclosingEntityIndicator' => true,
'extractedDate' => '2023-12-25',
'includesNonBeneficiallyHeld' => true,
'industryCodes' => [
[
'code' => '<string>',
'description' => '<string>'
]
],
'industryDeclarations' => [
[
'description' => '<string>',
'language' => '<string>'
]
],
'kycCustomerType' => '<string>',
'lastCheckDate' => '2023-12-25',
'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' => '2023-12-25',
'number' => '<string>',
'previousNumber' => '<string>',
'registryCode' => '<string>',
'registryDescription' => '<string>',
'state' => '<string>',
'unstructuredDate' => '<string>',
'unstructuredFoundationDate' => '<string>'
],
'registries' => [
'abr' => [
'abn' => '<string>',
'acn' => '<string>',
'addresses' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z',
'postcode' => '<string>',
'stateCode' => '<string>'
]
],
'businessNames' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'type' => '<string>'
]
],
'charityEndorsements' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z',
'type' => '<string>'
]
],
'charityTypes' => [
[
'description' => '<string>',
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z'
]
],
'description' => '<string>',
'dgrEndorsements' => [
[
'endorsedFrom' => '2023-11-07T05:31:56Z',
'endorsedTo' => '2023-11-07T05:31:56Z'
]
],
'gst' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z'
]
],
'historicalChanges' => [
[
'businessName' => [
'<string>'
],
'date' => '2023-11-07T05:31:56Z',
'entityStatus' => [
'<string>'
],
'goodsAndServicesTax' => [
'<string>'
],
'mainBusinessPhysicalAddress' => [
'<string>'
],
'mainName' => [
'<string>'
],
'mainTradingName' => [
'<string>'
]
]
],
'lastUpdated' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'registeredDate' => '2023-11-07T05:31:56Z',
'status' => '<string>',
'statusEffectiveFrom' => '<string>',
'type' => '<string>',
'typeCode' => '<string>',
'updatedDate' => '2023-11-07T05:31:56Z'
]
],
'reviewDate' => '2023-12-25',
'shareStructure' => [
[
'amountDue' => 123,
'amountPaid' => 123,
'classCode' => '<string>',
'classTitle' => '<string>',
'docNumber' => '<string>',
'docNumberQualifier' => '<string>',
'sharesIssued' => 123,
'status' => '<string>'
]
],
'startDate' => '2023-12-25',
'status' => [
'code' => '<string>',
'description' => '<string>'
],
'subType' => [
'code' => '<string>',
'description' => '<string>'
],
'subclass' => [
'code' => '<string>',
'description' => '<string>'
],
'type' => [
'code' => '<string>',
'description' => '<string>'
]
]
],
'deviceCheckDetails' => [
'activityType' => '<string>',
'additionalData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'checkSessionKey' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Frankie-CustomerID: <x-frankie-customerid>",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess"
payload := strings.NewReader("{\n \"entity\": {\n \"addresses\": [\n {\n \"country\": \"AUS\",\n \"addressId\": \"86932629-bdb4-158f-e670-741e89ff78ba\",\n \"addressType\": \"REGISTERED_OFFICE\",\n \"buildingName\": \"Highland Tower\",\n \"careOf\": \"<string>\",\n \"endDate\": \"0001-01-01\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"longForm\": \"42a Test Eagle Road, Testville, TST 123-TST, Testalia\",\n \"postalCode\": \"3000\",\n \"region\": \"MELBOURNE\",\n \"startDate\": \"2023-03-10\",\n \"state\": \"VIC\",\n \"streetName\": \"9 ROYCE AVENUE\",\n \"streetNumber\": \"FLAT 27\",\n \"streetType\": \"Road\",\n \"suburb\": \"Testburb\",\n \"town\": \"MELBOURNE\",\n \"unitNumber\": \"FLAT 27\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"AUS\",\n \"dateOfBirth\": \"1978-11-12\",\n \"locality\": \"Brisbane\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"1978\"\n },\n \"entityId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"ORGANISATION\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"F\",\n \"identityDocs\": [\n {\n \"country\": \"AUS\",\n \"idType\": \"DRIVERS_LICENCE\",\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"2020-06-02\",\n \"scanData\": \"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==\",\n \"scanDataRetrievalState\": \"NORMAL\",\n \"scanDocId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"scanFilename\": \"Important Document - ID1234567.pdf\",\n \"scanMIME\": \"image/png\",\n \"scanPageNum\": 1,\n \"scanSide\": \"F\",\n \"scanType\": \"PDF\"\n }\n ],\n \"documentId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"documentStatus\": \"DOC_SCANNED\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"idExpiry\": \"2020-02-01\",\n \"idIssued\": \"1972-11-04\",\n \"idNumber\": \"123456789\",\n \"idSubType\": \"<string>\",\n \"region\": \"VIC\"\n }\n ],\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\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 \"extractedDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"2023-11-07T05:31:56Z\",\n \"endorsedTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"2023-11-07T05:31:56Z\",\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\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"registeredDate\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"reviewDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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 \"deviceCheckDetails\": {\n \"activityType\": \"<string>\",\n \"additionalData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"checkSessionKey\": \"<string>\"\n }\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/compliance/v1.2/entity/{entityId}/idvalidate/initProcess")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": {\n \"addresses\": [\n {\n \"country\": \"AUS\",\n \"addressId\": \"86932629-bdb4-158f-e670-741e89ff78ba\",\n \"addressType\": \"REGISTERED_OFFICE\",\n \"buildingName\": \"Highland Tower\",\n \"careOf\": \"<string>\",\n \"endDate\": \"0001-01-01\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"longForm\": \"42a Test Eagle Road, Testville, TST 123-TST, Testalia\",\n \"postalCode\": \"3000\",\n \"region\": \"MELBOURNE\",\n \"startDate\": \"2023-03-10\",\n \"state\": \"VIC\",\n \"streetName\": \"9 ROYCE AVENUE\",\n \"streetNumber\": \"FLAT 27\",\n \"streetType\": \"Road\",\n \"suburb\": \"Testburb\",\n \"town\": \"MELBOURNE\",\n \"unitNumber\": \"FLAT 27\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"AUS\",\n \"dateOfBirth\": \"1978-11-12\",\n \"locality\": \"Brisbane\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"1978\"\n },\n \"entityId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"ORGANISATION\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"F\",\n \"identityDocs\": [\n {\n \"country\": \"AUS\",\n \"idType\": \"DRIVERS_LICENCE\",\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"2020-06-02\",\n \"scanData\": \"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==\",\n \"scanDataRetrievalState\": \"NORMAL\",\n \"scanDocId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"scanFilename\": \"Important Document - ID1234567.pdf\",\n \"scanMIME\": \"image/png\",\n \"scanPageNum\": 1,\n \"scanSide\": \"F\",\n \"scanType\": \"PDF\"\n }\n ],\n \"documentId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"documentStatus\": \"DOC_SCANNED\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"idExpiry\": \"2020-02-01\",\n \"idIssued\": \"1972-11-04\",\n \"idNumber\": \"123456789\",\n \"idSubType\": \"<string>\",\n \"region\": \"VIC\"\n }\n ],\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\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 \"extractedDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"2023-11-07T05:31:56Z\",\n \"endorsedTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"2023-11-07T05:31:56Z\",\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\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"registeredDate\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"reviewDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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 \"deviceCheckDetails\": {\n \"activityType\": \"<string>\",\n \"additionalData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"checkSessionKey\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess")
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 \"entity\": {\n \"addresses\": [\n {\n \"country\": \"AUS\",\n \"addressId\": \"86932629-bdb4-158f-e670-741e89ff78ba\",\n \"addressType\": \"REGISTERED_OFFICE\",\n \"buildingName\": \"Highland Tower\",\n \"careOf\": \"<string>\",\n \"endDate\": \"0001-01-01\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"longForm\": \"42a Test Eagle Road, Testville, TST 123-TST, Testalia\",\n \"postalCode\": \"3000\",\n \"region\": \"MELBOURNE\",\n \"startDate\": \"2023-03-10\",\n \"state\": \"VIC\",\n \"streetName\": \"9 ROYCE AVENUE\",\n \"streetNumber\": \"FLAT 27\",\n \"streetType\": \"Road\",\n \"suburb\": \"Testburb\",\n \"town\": \"MELBOURNE\",\n \"unitNumber\": \"FLAT 27\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"AUS\",\n \"dateOfBirth\": \"1978-11-12\",\n \"locality\": \"Brisbane\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"1978\"\n },\n \"entityId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"ORGANISATION\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"F\",\n \"identityDocs\": [\n {\n \"country\": \"AUS\",\n \"idType\": \"DRIVERS_LICENCE\",\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"2020-06-02\",\n \"scanData\": \"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==\",\n \"scanDataRetrievalState\": \"NORMAL\",\n \"scanDocId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"scanFilename\": \"Important Document - ID1234567.pdf\",\n \"scanMIME\": \"image/png\",\n \"scanPageNum\": 1,\n \"scanSide\": \"F\",\n \"scanType\": \"PDF\"\n }\n ],\n \"documentId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"documentStatus\": \"DOC_SCANNED\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"idExpiry\": \"2020-02-01\",\n \"idIssued\": \"1972-11-04\",\n \"idNumber\": \"123456789\",\n \"idSubType\": \"<string>\",\n \"region\": \"VIC\"\n }\n ],\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\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 \"extractedDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"2023-11-07T05:31:56Z\",\n \"endorsedTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"2023-11-07T05:31:56Z\",\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\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"registeredDate\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"reviewDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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 \"deviceCheckDetails\": {\n \"activityType\": \"<string>\",\n \"additionalData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"checkSessionKey\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"applicantId": "<string>",
"entity": {
"addresses": [
{
"country": "AUS",
"addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
"addressType": "REGISTERED_OFFICE",
"buildingName": "Highland Tower",
"careOf": "<string>",
"endDate": "0001-01-01",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "3000",
"region": "MELBOURNE",
"startDate": "2023-03-10",
"state": "VIC",
"streetName": "9 ROYCE AVENUE",
"streetNumber": "FLAT 27",
"streetType": "Road",
"suburb": "Testburb",
"town": "MELBOURNE",
"unitNumber": "FLAT 27",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "1978"
},
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "<string>",
"entityType": "ORGANISATION",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "F",
"identityDocs": [
{
"country": "AUS",
"idType": "DRIVERS_LICENCE",
"createdFromScan": true,
"docScan": [
{
"ScanDelete": true,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "image/png",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "<string>",
"manuallyModified": "false",
"region": "VIC"
}
],
"name": {
"familyName": "Smith",
"displayName": "Jane Cecily Smith",
"givenName": "Jane",
"honourific": "Duchess",
"middleName": "Cecily"
},
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"extractedDate": "2023-12-25",
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "2023-12-25",
"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": "2023-12-25",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "2023-11-07T05:31:56Z",
"endorsedTo": "2023-11-07T05:31:56Z"
}
],
"gst": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "2023-11-07T05:31:56Z",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"registeredDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
},
"reviewDate": "2023-12-25",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "2023-12-25",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"token": "<string>",
"supportTwoDocs": true
}{
"checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"function": "<string>",
"linkURL": "<string>",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}Entity
Update Entity and Initiate IDV Process
Update an entity object and if successful, start the process of downloading the captured data and processing the reports and results of the ID validation process.
At a minimum, the entity will need to have a name. For best results, you should gather the DoB, address, ID document details as well before calling this initProcess function, or supply the details as part of this update.
The IDV process may run various checks against the photos and videos supplied by the applicant.
These check types are configured on request and can include:
- ID Validation (Document) - Looks at the picture(s) of the identity document, and does checks about image quality, as well as specific things about the id itself, such as whether it is expired or is for someone under 18. The image is also OCR’d and the OCR results are compared against the data entered for any KYC checks to make sure that it is the same document.
- Facial Photo Comparison - Compares the portrait picture of the identity document, to the “selfie” taken as part of the idv process. The selfie can be either a still photo or a live video (preferred). This checks both that the selfie taken is valid and not manipulated, and that it is a reasonable match to the picture on the identity document. The exact algorithm to determine matches and quality is dependant on the provider chosen.
- Facial Duplicate - Compares the selfie provided with previous selfies for other applicants. This check type is trying to identify based on the selfie whether this applicant has already registered under a different name and potentially with faked identification. If there is a potential match then the applicant is flagged for review.
POST
/
entity
/
{entityId}
/
idvalidate
/
initProcess
Update Entity and Initiate IDV Process
curl --request POST \
--url https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"entity": {
"addresses": [
{
"country": "AUS",
"addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
"addressType": "REGISTERED_OFFICE",
"buildingName": "Highland Tower",
"careOf": "<string>",
"endDate": "0001-01-01",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "3000",
"region": "MELBOURNE",
"startDate": "2023-03-10",
"state": "VIC",
"streetName": "9 ROYCE AVENUE",
"streetNumber": "FLAT 27",
"streetType": "Road",
"suburb": "Testburb",
"town": "MELBOURNE",
"unitNumber": "FLAT 27",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "1978"
},
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "<string>",
"entityType": "ORGANISATION",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "F",
"identityDocs": [
{
"country": "AUS",
"idType": "DRIVERS_LICENCE",
"docScan": [
{
"ScanDelete": true,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "image/png",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "<string>",
"region": "VIC"
}
],
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"extractedDate": "2023-12-25",
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "2023-12-25",
"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": "2023-12-25",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "2023-11-07T05:31:56Z",
"endorsedTo": "2023-11-07T05:31:56Z"
}
],
"gst": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "2023-11-07T05:31:56Z",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"registeredDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
},
"reviewDate": "2023-12-25",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "2023-12-25",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"deviceCheckDetails": {
"activityType": "<string>",
"additionalData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"checkSessionKey": "<string>"
}
}
'import requests
url = "https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess"
payload = {
"entity": {
"addresses": [
{
"country": "AUS",
"addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
"addressType": "REGISTERED_OFFICE",
"buildingName": "Highland Tower",
"careOf": "<string>",
"endDate": "0001-01-01",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "3000",
"region": "MELBOURNE",
"startDate": "2023-03-10",
"state": "VIC",
"streetName": "9 ROYCE AVENUE",
"streetNumber": "FLAT 27",
"streetType": "Road",
"suburb": "Testburb",
"town": "MELBOURNE",
"unitNumber": "FLAT 27",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "1978"
},
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "<string>",
"entityType": "ORGANISATION",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "F",
"identityDocs": [
{
"country": "AUS",
"idType": "DRIVERS_LICENCE",
"docScan": [
{
"ScanDelete": True,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "image/png",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "<string>",
"region": "VIC"
}
],
"organisationData": {
"adverseCreditDataPresent": True,
"aliases": ["<string>"],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": True,
"extractedDate": "2023-12-25",
"includesNonBeneficiallyHeld": True,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "2023-12-25",
"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": "2023-12-25",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": { "abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "2023-11-07T05:31:56Z",
"endorsedTo": "2023-11-07T05:31:56Z"
}
],
"gst": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"historicalChanges": [
{
"businessName": ["<string>"],
"date": "2023-11-07T05:31:56Z",
"entityStatus": ["<string>"],
"goodsAndServicesTax": ["<string>"],
"mainBusinessPhysicalAddress": ["<string>"],
"mainName": ["<string>"],
"mainTradingName": ["<string>"]
}
],
"lastUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"registeredDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
} },
"reviewDate": "2023-12-25",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "2023-12-25",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"deviceCheckDetails": {
"activityType": "<string>",
"additionalData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"checkSessionKey": "<string>"
}
}
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({
entity: {
addresses: [
{
country: 'AUS',
addressId: '86932629-bdb4-158f-e670-741e89ff78ba',
addressType: 'REGISTERED_OFFICE',
buildingName: 'Highland Tower',
careOf: '<string>',
endDate: '0001-01-01',
extraData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
longForm: '42a Test Eagle Road, Testville, TST 123-TST, Testalia',
postalCode: '3000',
region: 'MELBOURNE',
startDate: '2023-03-10',
state: 'VIC',
streetName: '9 ROYCE AVENUE',
streetNumber: 'FLAT 27',
streetType: 'Road',
suburb: 'Testburb',
town: 'MELBOURNE',
unitNumber: 'FLAT 27',
unstructuredLongForm: '<string>'
}
],
dateOfBirth: {
country: 'AUS',
dateOfBirth: '1978-11-12',
locality: 'Brisbane',
unstructuredDateOfBirth: '<string>',
yearOfBirth: '1978'
},
entityId: '84a9a860-68ae-4d7d-9a53-54a1116d5051',
entityProfile: '<string>',
entityType: 'ORGANISATION',
extraData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
flags: [{flag: '<string>', value: 123}],
gender: 'F',
identityDocs: [
{
country: 'AUS',
idType: 'DRIVERS_LICENCE',
docScan: [
{
ScanDelete: true,
scanCreated: '2020-06-02',
scanData: 'VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==',
scanDataRetrievalState: 'NORMAL',
scanDocId: '84a9a860-68ae-4d7d-9a53-54a1116d5051',
scanFilename: 'Important Document - ID1234567.pdf',
scanMIME: 'image/png',
scanPageNum: 1,
scanSide: 'F',
scanType: 'PDF'
}
],
documentId: '84a9a860-68ae-4d7d-9a53-54a1116d5051',
documentStatus: 'DOC_SCANNED',
extraData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
idExpiry: '2020-02-01',
idIssued: '1972-11-04',
idNumber: '123456789',
idSubType: '<string>',
region: 'VIC'
}
],
organisationData: {
adverseCreditDataPresent: true,
aliases: ['<string>'],
class: {code: '<string>', description: '<string>'},
contactDetails: {
email: '<string>',
faxNumber: '<string>',
telephoneNumber: '<string>',
websiteURL: '<string>'
},
disclosingEntityIndicator: true,
extractedDate: '2023-12-25',
includesNonBeneficiallyHeld: true,
industryCodes: [{code: '<string>', description: '<string>'}],
industryDeclarations: [{description: '<string>', language: '<string>'}],
kycCustomerType: '<string>',
lastCheckDate: '2023-12-25',
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: '2023-12-25',
number: '<string>',
previousNumber: '<string>',
registryCode: '<string>',
registryDescription: '<string>',
state: '<string>',
unstructuredDate: '<string>',
unstructuredFoundationDate: '<string>'
},
registries: {
abr: {
abn: '<string>',
acn: '<string>',
addresses: [
{
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z',
postcode: '<string>',
stateCode: '<string>'
}
],
businessNames: [
{
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z',
name: '<string>',
type: '<string>'
}
],
charityEndorsements: [
{
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z',
type: '<string>'
}
],
charityTypes: [
{
description: '<string>',
effectiveFrom: '2023-11-07T05:31:56Z',
effectiveTo: '2023-11-07T05:31:56Z'
}
],
description: '<string>',
dgrEndorsements: [{endorsedFrom: '2023-11-07T05:31:56Z', endorsedTo: '2023-11-07T05:31:56Z'}],
gst: [{effectiveFrom: '2023-11-07T05:31:56Z', effectiveTo: '2023-11-07T05:31:56Z'}],
historicalChanges: [
{
businessName: ['<string>'],
date: '2023-11-07T05:31:56Z',
entityStatus: ['<string>'],
goodsAndServicesTax: ['<string>'],
mainBusinessPhysicalAddress: ['<string>'],
mainName: ['<string>'],
mainTradingName: ['<string>']
}
],
lastUpdated: '2023-11-07T05:31:56Z',
name: '<string>',
registeredDate: '2023-11-07T05:31:56Z',
status: '<string>',
statusEffectiveFrom: '<string>',
type: '<string>',
typeCode: '<string>',
updatedDate: '2023-11-07T05:31:56Z'
}
},
reviewDate: '2023-12-25',
shareStructure: [
{
amountDue: 123,
amountPaid: 123,
classCode: '<string>',
classTitle: '<string>',
docNumber: '<string>',
docNumberQualifier: '<string>',
sharesIssued: 123,
status: '<string>'
}
],
startDate: '2023-12-25',
status: {code: '<string>', description: '<string>'},
subType: {code: '<string>', description: '<string>'},
subclass: {code: '<string>', description: '<string>'},
type: {code: '<string>', description: '<string>'}
}
},
deviceCheckDetails: {
activityType: '<string>',
additionalData: [{kvpKey: 'ACN', kvpType: 'id.external', kvpValue: '406655338'}],
checkSessionKey: '<string>'
}
})
};
fetch('https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess', 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/compliance/v1.2/entity/{entityId}/idvalidate/initProcess",
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([
'entity' => [
'addresses' => [
[
'country' => 'AUS',
'addressId' => '86932629-bdb4-158f-e670-741e89ff78ba',
'addressType' => 'REGISTERED_OFFICE',
'buildingName' => 'Highland Tower',
'careOf' => '<string>',
'endDate' => '0001-01-01',
'extraData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'longForm' => '42a Test Eagle Road, Testville, TST 123-TST, Testalia',
'postalCode' => '3000',
'region' => 'MELBOURNE',
'startDate' => '2023-03-10',
'state' => 'VIC',
'streetName' => '9 ROYCE AVENUE',
'streetNumber' => 'FLAT 27',
'streetType' => 'Road',
'suburb' => 'Testburb',
'town' => 'MELBOURNE',
'unitNumber' => 'FLAT 27',
'unstructuredLongForm' => '<string>'
]
],
'dateOfBirth' => [
'country' => 'AUS',
'dateOfBirth' => '1978-11-12',
'locality' => 'Brisbane',
'unstructuredDateOfBirth' => '<string>',
'yearOfBirth' => '1978'
],
'entityId' => '84a9a860-68ae-4d7d-9a53-54a1116d5051',
'entityProfile' => '<string>',
'entityType' => 'ORGANISATION',
'extraData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'flags' => [
[
'flag' => '<string>',
'value' => 123
]
],
'gender' => 'F',
'identityDocs' => [
[
'country' => 'AUS',
'idType' => 'DRIVERS_LICENCE',
'docScan' => [
[
'ScanDelete' => true,
'scanCreated' => '2020-06-02',
'scanData' => 'VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==',
'scanDataRetrievalState' => 'NORMAL',
'scanDocId' => '84a9a860-68ae-4d7d-9a53-54a1116d5051',
'scanFilename' => 'Important Document - ID1234567.pdf',
'scanMIME' => 'image/png',
'scanPageNum' => 1,
'scanSide' => 'F',
'scanType' => 'PDF'
]
],
'documentId' => '84a9a860-68ae-4d7d-9a53-54a1116d5051',
'documentStatus' => 'DOC_SCANNED',
'extraData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'idExpiry' => '2020-02-01',
'idIssued' => '1972-11-04',
'idNumber' => '123456789',
'idSubType' => '<string>',
'region' => 'VIC'
]
],
'organisationData' => [
'adverseCreditDataPresent' => true,
'aliases' => [
'<string>'
],
'class' => [
'code' => '<string>',
'description' => '<string>'
],
'contactDetails' => [
'email' => '<string>',
'faxNumber' => '<string>',
'telephoneNumber' => '<string>',
'websiteURL' => '<string>'
],
'disclosingEntityIndicator' => true,
'extractedDate' => '2023-12-25',
'includesNonBeneficiallyHeld' => true,
'industryCodes' => [
[
'code' => '<string>',
'description' => '<string>'
]
],
'industryDeclarations' => [
[
'description' => '<string>',
'language' => '<string>'
]
],
'kycCustomerType' => '<string>',
'lastCheckDate' => '2023-12-25',
'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' => '2023-12-25',
'number' => '<string>',
'previousNumber' => '<string>',
'registryCode' => '<string>',
'registryDescription' => '<string>',
'state' => '<string>',
'unstructuredDate' => '<string>',
'unstructuredFoundationDate' => '<string>'
],
'registries' => [
'abr' => [
'abn' => '<string>',
'acn' => '<string>',
'addresses' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z',
'postcode' => '<string>',
'stateCode' => '<string>'
]
],
'businessNames' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'type' => '<string>'
]
],
'charityEndorsements' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z',
'type' => '<string>'
]
],
'charityTypes' => [
[
'description' => '<string>',
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z'
]
],
'description' => '<string>',
'dgrEndorsements' => [
[
'endorsedFrom' => '2023-11-07T05:31:56Z',
'endorsedTo' => '2023-11-07T05:31:56Z'
]
],
'gst' => [
[
'effectiveFrom' => '2023-11-07T05:31:56Z',
'effectiveTo' => '2023-11-07T05:31:56Z'
]
],
'historicalChanges' => [
[
'businessName' => [
'<string>'
],
'date' => '2023-11-07T05:31:56Z',
'entityStatus' => [
'<string>'
],
'goodsAndServicesTax' => [
'<string>'
],
'mainBusinessPhysicalAddress' => [
'<string>'
],
'mainName' => [
'<string>'
],
'mainTradingName' => [
'<string>'
]
]
],
'lastUpdated' => '2023-11-07T05:31:56Z',
'name' => '<string>',
'registeredDate' => '2023-11-07T05:31:56Z',
'status' => '<string>',
'statusEffectiveFrom' => '<string>',
'type' => '<string>',
'typeCode' => '<string>',
'updatedDate' => '2023-11-07T05:31:56Z'
]
],
'reviewDate' => '2023-12-25',
'shareStructure' => [
[
'amountDue' => 123,
'amountPaid' => 123,
'classCode' => '<string>',
'classTitle' => '<string>',
'docNumber' => '<string>',
'docNumberQualifier' => '<string>',
'sharesIssued' => 123,
'status' => '<string>'
]
],
'startDate' => '2023-12-25',
'status' => [
'code' => '<string>',
'description' => '<string>'
],
'subType' => [
'code' => '<string>',
'description' => '<string>'
],
'subclass' => [
'code' => '<string>',
'description' => '<string>'
],
'type' => [
'code' => '<string>',
'description' => '<string>'
]
]
],
'deviceCheckDetails' => [
'activityType' => '<string>',
'additionalData' => [
[
'kvpKey' => 'ACN',
'kvpType' => 'id.external',
'kvpValue' => '406655338'
]
],
'checkSessionKey' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Frankie-CustomerID: <x-frankie-customerid>",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess"
payload := strings.NewReader("{\n \"entity\": {\n \"addresses\": [\n {\n \"country\": \"AUS\",\n \"addressId\": \"86932629-bdb4-158f-e670-741e89ff78ba\",\n \"addressType\": \"REGISTERED_OFFICE\",\n \"buildingName\": \"Highland Tower\",\n \"careOf\": \"<string>\",\n \"endDate\": \"0001-01-01\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"longForm\": \"42a Test Eagle Road, Testville, TST 123-TST, Testalia\",\n \"postalCode\": \"3000\",\n \"region\": \"MELBOURNE\",\n \"startDate\": \"2023-03-10\",\n \"state\": \"VIC\",\n \"streetName\": \"9 ROYCE AVENUE\",\n \"streetNumber\": \"FLAT 27\",\n \"streetType\": \"Road\",\n \"suburb\": \"Testburb\",\n \"town\": \"MELBOURNE\",\n \"unitNumber\": \"FLAT 27\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"AUS\",\n \"dateOfBirth\": \"1978-11-12\",\n \"locality\": \"Brisbane\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"1978\"\n },\n \"entityId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"ORGANISATION\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"F\",\n \"identityDocs\": [\n {\n \"country\": \"AUS\",\n \"idType\": \"DRIVERS_LICENCE\",\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"2020-06-02\",\n \"scanData\": \"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==\",\n \"scanDataRetrievalState\": \"NORMAL\",\n \"scanDocId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"scanFilename\": \"Important Document - ID1234567.pdf\",\n \"scanMIME\": \"image/png\",\n \"scanPageNum\": 1,\n \"scanSide\": \"F\",\n \"scanType\": \"PDF\"\n }\n ],\n \"documentId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"documentStatus\": \"DOC_SCANNED\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"idExpiry\": \"2020-02-01\",\n \"idIssued\": \"1972-11-04\",\n \"idNumber\": \"123456789\",\n \"idSubType\": \"<string>\",\n \"region\": \"VIC\"\n }\n ],\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\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 \"extractedDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"2023-11-07T05:31:56Z\",\n \"endorsedTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"2023-11-07T05:31:56Z\",\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\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"registeredDate\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"reviewDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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 \"deviceCheckDetails\": {\n \"activityType\": \"<string>\",\n \"additionalData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"checkSessionKey\": \"<string>\"\n }\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/compliance/v1.2/entity/{entityId}/idvalidate/initProcess")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"entity\": {\n \"addresses\": [\n {\n \"country\": \"AUS\",\n \"addressId\": \"86932629-bdb4-158f-e670-741e89ff78ba\",\n \"addressType\": \"REGISTERED_OFFICE\",\n \"buildingName\": \"Highland Tower\",\n \"careOf\": \"<string>\",\n \"endDate\": \"0001-01-01\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"longForm\": \"42a Test Eagle Road, Testville, TST 123-TST, Testalia\",\n \"postalCode\": \"3000\",\n \"region\": \"MELBOURNE\",\n \"startDate\": \"2023-03-10\",\n \"state\": \"VIC\",\n \"streetName\": \"9 ROYCE AVENUE\",\n \"streetNumber\": \"FLAT 27\",\n \"streetType\": \"Road\",\n \"suburb\": \"Testburb\",\n \"town\": \"MELBOURNE\",\n \"unitNumber\": \"FLAT 27\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"AUS\",\n \"dateOfBirth\": \"1978-11-12\",\n \"locality\": \"Brisbane\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"1978\"\n },\n \"entityId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"ORGANISATION\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"F\",\n \"identityDocs\": [\n {\n \"country\": \"AUS\",\n \"idType\": \"DRIVERS_LICENCE\",\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"2020-06-02\",\n \"scanData\": \"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==\",\n \"scanDataRetrievalState\": \"NORMAL\",\n \"scanDocId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"scanFilename\": \"Important Document - ID1234567.pdf\",\n \"scanMIME\": \"image/png\",\n \"scanPageNum\": 1,\n \"scanSide\": \"F\",\n \"scanType\": \"PDF\"\n }\n ],\n \"documentId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"documentStatus\": \"DOC_SCANNED\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"idExpiry\": \"2020-02-01\",\n \"idIssued\": \"1972-11-04\",\n \"idNumber\": \"123456789\",\n \"idSubType\": \"<string>\",\n \"region\": \"VIC\"\n }\n ],\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\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 \"extractedDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"2023-11-07T05:31:56Z\",\n \"endorsedTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"2023-11-07T05:31:56Z\",\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\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"registeredDate\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"reviewDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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 \"deviceCheckDetails\": {\n \"activityType\": \"<string>\",\n \"additionalData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"checkSessionKey\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/compliance/v1.2/entity/{entityId}/idvalidate/initProcess")
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 \"entity\": {\n \"addresses\": [\n {\n \"country\": \"AUS\",\n \"addressId\": \"86932629-bdb4-158f-e670-741e89ff78ba\",\n \"addressType\": \"REGISTERED_OFFICE\",\n \"buildingName\": \"Highland Tower\",\n \"careOf\": \"<string>\",\n \"endDate\": \"0001-01-01\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"longForm\": \"42a Test Eagle Road, Testville, TST 123-TST, Testalia\",\n \"postalCode\": \"3000\",\n \"region\": \"MELBOURNE\",\n \"startDate\": \"2023-03-10\",\n \"state\": \"VIC\",\n \"streetName\": \"9 ROYCE AVENUE\",\n \"streetNumber\": \"FLAT 27\",\n \"streetType\": \"Road\",\n \"suburb\": \"Testburb\",\n \"town\": \"MELBOURNE\",\n \"unitNumber\": \"FLAT 27\",\n \"unstructuredLongForm\": \"<string>\"\n }\n ],\n \"dateOfBirth\": {\n \"country\": \"AUS\",\n \"dateOfBirth\": \"1978-11-12\",\n \"locality\": \"Brisbane\",\n \"unstructuredDateOfBirth\": \"<string>\",\n \"yearOfBirth\": \"1978\"\n },\n \"entityId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"entityProfile\": \"<string>\",\n \"entityType\": \"ORGANISATION\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"flags\": [\n {\n \"flag\": \"<string>\",\n \"value\": 123\n }\n ],\n \"gender\": \"F\",\n \"identityDocs\": [\n {\n \"country\": \"AUS\",\n \"idType\": \"DRIVERS_LICENCE\",\n \"docScan\": [\n {\n \"ScanDelete\": true,\n \"scanCreated\": \"2020-06-02\",\n \"scanData\": \"VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==\",\n \"scanDataRetrievalState\": \"NORMAL\",\n \"scanDocId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"scanFilename\": \"Important Document - ID1234567.pdf\",\n \"scanMIME\": \"image/png\",\n \"scanPageNum\": 1,\n \"scanSide\": \"F\",\n \"scanType\": \"PDF\"\n }\n ],\n \"documentId\": \"84a9a860-68ae-4d7d-9a53-54a1116d5051\",\n \"documentStatus\": \"DOC_SCANNED\",\n \"extraData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"idExpiry\": \"2020-02-01\",\n \"idIssued\": \"1972-11-04\",\n \"idNumber\": \"123456789\",\n \"idSubType\": \"<string>\",\n \"region\": \"VIC\"\n }\n ],\n \"organisationData\": {\n \"adverseCreditDataPresent\": true,\n \"aliases\": [\n \"<string>\"\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 \"extractedDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-12-25\",\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\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"postcode\": \"<string>\",\n \"stateCode\": \"<string>\"\n }\n ],\n \"businessNames\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"charityEndorsements\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\",\n \"type\": \"<string>\"\n }\n ],\n \"charityTypes\": [\n {\n \"description\": \"<string>\",\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"description\": \"<string>\",\n \"dgrEndorsements\": [\n {\n \"endorsedFrom\": \"2023-11-07T05:31:56Z\",\n \"endorsedTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"gst\": [\n {\n \"effectiveFrom\": \"2023-11-07T05:31:56Z\",\n \"effectiveTo\": \"2023-11-07T05:31:56Z\"\n }\n ],\n \"historicalChanges\": [\n {\n \"businessName\": [\n \"<string>\"\n ],\n \"date\": \"2023-11-07T05:31:56Z\",\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\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"registeredDate\": \"2023-11-07T05:31:56Z\",\n \"status\": \"<string>\",\n \"statusEffectiveFrom\": \"<string>\",\n \"type\": \"<string>\",\n \"typeCode\": \"<string>\",\n \"updatedDate\": \"2023-11-07T05:31:56Z\"\n }\n },\n \"reviewDate\": \"2023-12-25\",\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\": \"2023-12-25\",\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 \"deviceCheckDetails\": {\n \"activityType\": \"<string>\",\n \"additionalData\": [\n {\n \"kvpKey\": \"ACN\",\n \"kvpType\": \"id.external\",\n \"kvpValue\": \"406655338\"\n }\n ],\n \"checkSessionKey\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"applicantId": "<string>",
"entity": {
"addresses": [
{
"country": "AUS",
"addressId": "86932629-bdb4-158f-e670-741e89ff78ba",
"addressType": "REGISTERED_OFFICE",
"buildingName": "Highland Tower",
"careOf": "<string>",
"endDate": "0001-01-01",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"longForm": "42a Test Eagle Road, Testville, TST 123-TST, Testalia",
"postalCode": "3000",
"region": "MELBOURNE",
"startDate": "2023-03-10",
"state": "VIC",
"streetName": "9 ROYCE AVENUE",
"streetNumber": "FLAT 27",
"streetType": "Road",
"suburb": "Testburb",
"town": "MELBOURNE",
"unitNumber": "FLAT 27",
"unstructuredLongForm": "<string>"
}
],
"dateOfBirth": {
"country": "AUS",
"dateOfBirth": "1978-11-12",
"locality": "Brisbane",
"unstructuredDateOfBirth": "<string>",
"yearOfBirth": "1978"
},
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"entityProfile": "<string>",
"entityType": "ORGANISATION",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"flags": [
{
"flag": "<string>",
"value": 123
}
],
"gender": "F",
"identityDocs": [
{
"country": "AUS",
"idType": "DRIVERS_LICENCE",
"createdFromScan": true,
"docScan": [
{
"ScanDelete": true,
"scanCreated": "2020-06-02",
"scanData": "VGhpcyBpcyBzb21lIGV4YW1wbGUgZGF0YS4gV29vLCBJIGJldCB5b3UgcmVncmV0IHRoZSB0aW1lIHlvdSB3YXN0ZWQgZGVjb2RpbmcgdGhpcywgaHVoPw==",
"scanDataRetrievalState": "NORMAL",
"scanDocId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"scanFilename": "Important Document - ID1234567.pdf",
"scanMIME": "image/png",
"scanPageNum": 1,
"scanSide": "F",
"scanType": "PDF"
}
],
"documentId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"documentStatus": "DOC_SCANNED",
"extraData": [
{
"kvpKey": "ACN",
"kvpType": "id.external",
"kvpValue": "406655338"
}
],
"idExpiry": "2020-02-01",
"idIssued": "1972-11-04",
"idNumber": "123456789",
"idSubType": "<string>",
"manuallyModified": "false",
"region": "VIC"
}
],
"name": {
"familyName": "Smith",
"displayName": "Jane Cecily Smith",
"givenName": "Jane",
"honourific": "Duchess",
"middleName": "Cecily"
},
"organisationData": {
"adverseCreditDataPresent": true,
"aliases": [
"<string>"
],
"class": {
"code": "<string>",
"description": "<string>"
},
"contactDetails": {
"email": "<string>",
"faxNumber": "<string>",
"telephoneNumber": "<string>",
"websiteURL": "<string>"
},
"disclosingEntityIndicator": true,
"extractedDate": "2023-12-25",
"includesNonBeneficiallyHeld": true,
"industryCodes": [
{
"code": "<string>",
"description": "<string>"
}
],
"industryDeclarations": [
{
"description": "<string>",
"language": "<string>"
}
],
"kycCustomerType": "<string>",
"lastCheckDate": "2023-12-25",
"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": "2023-12-25",
"number": "<string>",
"previousNumber": "<string>",
"registryCode": "<string>",
"registryDescription": "<string>",
"state": "<string>",
"unstructuredDate": "<string>",
"unstructuredFoundationDate": "<string>"
},
"registries": {
"abr": {
"abn": "<string>",
"acn": "<string>",
"addresses": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"postcode": "<string>",
"stateCode": "<string>"
}
],
"businessNames": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "<string>"
}
],
"charityEndorsements": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z",
"type": "<string>"
}
],
"charityTypes": [
{
"description": "<string>",
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"description": "<string>",
"dgrEndorsements": [
{
"endorsedFrom": "2023-11-07T05:31:56Z",
"endorsedTo": "2023-11-07T05:31:56Z"
}
],
"gst": [
{
"effectiveFrom": "2023-11-07T05:31:56Z",
"effectiveTo": "2023-11-07T05:31:56Z"
}
],
"historicalChanges": [
{
"businessName": [
"<string>"
],
"date": "2023-11-07T05:31:56Z",
"entityStatus": [
"<string>"
],
"goodsAndServicesTax": [
"<string>"
],
"mainBusinessPhysicalAddress": [
"<string>"
],
"mainName": [
"<string>"
],
"mainTradingName": [
"<string>"
]
}
],
"lastUpdated": "2023-11-07T05:31:56Z",
"name": "<string>",
"registeredDate": "2023-11-07T05:31:56Z",
"status": "<string>",
"statusEffectiveFrom": "<string>",
"type": "<string>",
"typeCode": "<string>",
"updatedDate": "2023-11-07T05:31:56Z"
}
},
"reviewDate": "2023-12-25",
"shareStructure": [
{
"amountDue": 123,
"amountPaid": 123,
"classCode": "<string>",
"classTitle": "<string>",
"docNumber": "<string>",
"docNumberQualifier": "<string>",
"sharesIssued": 123,
"status": "<string>"
}
],
"startDate": "2023-12-25",
"status": {
"code": "<string>",
"description": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>"
},
"subclass": {
"code": "<string>",
"description": "<string>"
},
"type": {
"code": "<string>",
"description": "<string>"
}
}
},
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"token": "<string>",
"supportTwoDocs": true
}{
"checkId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityId": "84a9a860-68ae-4d7d-9a53-54a1116d5051",
"function": "<string>",
"linkURL": "<string>",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}{
"errorCode": "CORE-5990",
"errorMsg": "Everything went kaflooey. Stay clam.",
"requestId": "01BFJA617JMJXEW6G7TDDXNSHX",
"commit": "2af478ed",
"httpStatusCode": 501,
"issues": [
{
"issueLocation": "dateOfBirth",
"issue": "Invalid format. Must be YYYY-MM-DD"
}
]
}Authorizations
API key issued by Frankie Financial. 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.
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See out callback API for details on this.
See more details here: https://docs.frankieone.com/docs/asynchronous-calls-backgrounding-processes
Required range:
0 <= x <= 1Path Parameters
The entityId returned previously from an earlier call to /check or /entity
Body
application/json
The entity to update
Contains all the details we'll check regarding an Entity. It is assumed that this will grow over time.
Current supported check parameters:
- entity: The Entity we're checking. This must be supplied.
Describes all of the data being used to verify an entity.
Show child attributes
Show child attributes
Contains any/all details we want to pass on to the device checking service as part of an activity / transaction. A transaction isn't just a payment, but can represent a number of different interaction types. See below for more.
NOTE: If you're sending this data, then your recipe or requested checkTypes MUST include a "device" checkType. Otherwise this data will be ignored and dropped.
Show child attributes
Show child attributes
Response
The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.
Also returned is the applicantId and token to be in the IDV process.
Contains the results of a given document entity create/update and IDV token details.
The applicantId is either the same one that was supplied in the request for a fresh token, or a new one. This ID must be supplied along with the token to your SDK so that it knows who any uploaded documents are for.
The latest applicant will also be written to the extraData of the entity as well for safe keeping. Older applicantIds will be overwritten.
Describes all of the data being used to verify an entity.
Show child attributes
Show child attributes
Unique identifier for every request. Can be used for tracking down answers with technical support.
Uses the ULID format (a time-based, sortable UUID)
Note: this will be different for every request.
Example:
"01BFJA617JMJXEW6G7TDDXNSHX"
Token to be used in the SDK to authenticate the applicant and application/referrer.
Tokens are time limited (1 hour) and can only be used with the applicantId supplied.
If the requesting customer can support requesting 2 documents.
Was this page helpful?