Skip to main content
GET
/
v2.1
/
organizations
/
{entityId}
/
serviceprofiles
/
{serviceName}
/
workflows
/
{workflowName}
/
executions
/
{workflowExecutionId}
Get the result of a specific execution by its executionId
curl --request GET \
  --url https://api.uat.frankie.one/v2.1/organizations/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'
{
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"workflowResult": {
"schemaVersion": 123,
"workflowName": "<string>",
"workflowExecutionId": "<string>",
"workflowExecutionState": "COMPLETED",
"startedAt": "2023-11-07T05:31:56Z",
"workflowId": "<string>",
"requestId": "<string>",
"entityId": "<string>",
"entityType": "INDIVIDUAL",
"serviceProfileId": "<string>",
"result": "UNCHECKED",
"createdAt": "2023-11-07T05:31:56Z",
"status": "UNCHECKED",
"statusOverrideAt": "2023-11-07T05:31:56Z",
"statusOverrideRequestId": "<string>",
"statusOverrideBy": "<string>",
"riskAssessment": {
"serviceProfileId": "<string>",
"workflowId": "<string>",
"workflowExecutionId": "<string>",
"entityId": "<string>",
"riskAssessmentId": "<string>",
"schemaVersion": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>",
"workflowRiskScore": 123,
"workflowRiskLevel": "UNKNOWN",
"riskScore": 123,
"riskLevel": "UNKNOWN",
"isOutdated": false,
"riskFactors": [
{
"riskFactorId": "<string>",
"factor": "<string>",
"value": "<string>",
"score": 123,
"description": "<string>",
"workflowExecutionId": "<string>",
"stepResultId": "<string>",
"manualOverrideScore": 123,
"status": "VALID",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>",
"createdServiceProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdWorkflowExecutionId": "<string>",
"createdStepResultId": "<string>"
}
]
},
"isManual": true,
"steps": {
"order": [
"<string>"
],
"passed": [
"<string>"
],
"failed": [
"<string>"
],
"incomplete": [
"<string>"
],
"notApplicable": [
"<string>"
]
},
"endedAt": "2023-11-07T05:31:56Z",
"issues": [
{
"category": "AML",
"issue": "AML_ISSUE",
"severity": "INFO",
"issueId": "<string>",
"workflowExecutionId": "<string>",
"stepResultId": "<string>",
"isCleared": true,
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>"
}
],
"lifecyclePhase": "OTHER",
"monitoringTypes": [
"AML"
],
"endWorkflowId": "<string>",
"endWorkflowName": "<string>",
"workflowStepResults": [
{
"stepResultId": "<string>",
"workflowExecutionId": "<string>",
"stepName": "<string>",
"requestId": "<string>",
"objectType": "NAME",
"objectId": "<string>",
"schemaVersion": 123,
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"serviceProviders": [
{
"provider": "<string>",
"result": "<string>",
"order": 123,
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z"
}
],
"result": "UNCHECKED",
"errors": [
{
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"summary": {
"stepName": "<string>",
"matchedRules": [
{
"ruleName": "default",
"ruleOrder": 1,
"ruleMatches": [
{
"matchTypes": {},
"matchCount": 2,
"matchCountRequired": 1,
"hasAllRequiredSourcesMatched": true,
"requiredSourcesMatched": [
"<string>"
],
"requiredSourcesNotMatched": [
"<string>"
],
"isVerified": false,
"matchDetails": [
{
"provider": "<string>",
"source": "<string>",
"attributesMatched": [
"<string>"
]
}
],
"nonMatchDetails": [
{
"provider": "<string>",
"source": "<string>",
"attributesMatched": [
"<string>"
]
}
]
}
]
}
],
"unmatchedRules": [
{
"ruleName": "default",
"ruleOrder": 1,
"ruleMatches": [
{
"matchTypes": {},
"matchCount": 2,
"matchCountRequired": 1,
"hasAllRequiredSourcesMatched": true,
"requiredSourcesMatched": [
"<string>"
],
"requiredSourcesNotMatched": [
"<string>"
],
"isVerified": false,
"matchDetails": [
{
"provider": "<string>",
"source": "<string>",
"attributesMatched": [
"<string>"
]
}
],
"nonMatchDetails": [
{
"provider": "<string>",
"source": "<string>",
"attributesMatched": [
"<string>"
]
}
]
}
]
}
]
},
"risk": {
"level": "<string>",
"contributedScore": 123,
"overallScore": 123,
"factors": [
{
"factor": "<string>",
"score": 123,
"value": "<string>",
"aggregationMethod": "<string>",
"matchedRule": "<string>",
"source": "<string>",
"inputsConsidered": [
{
"value": "<string>",
"score": 123
}
]
}
]
},
"notes": {},
"processResults": [
{
"processResultId": "<string>",
"schemaVersion": 123,
"entityId": "<string>",
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"stepName": "<string>",
"stepType": "<string>",
"objectType": "<string>",
"objectId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"groupId": "<string>",
"providerResult": {
"name": "<string>",
"source": "<string>",
"sourceNormalized": "<string>",
"reference": "<string>",
"fuzziness": {
"normalized": 50,
"actual": "<string>"
},
"confidence": {
"normalized": 50,
"actual": "<string>"
},
"riskScore": 123,
"errorCode": "<string>",
"errorMessage": "<string>"
},
"result": "MATCH",
"class": "KYC",
"supplementaryData": {
"type": "AML",
"serviceProvider": "<string>",
"searchId": "<string>",
"caseId": "<string>",
"referenceId": "<string>",
"originalStepSearchLevel": "<string>",
"groupingId": "<string>",
"reportUrl": "<string>",
"fuzziness": {
"normalized": 50,
"actual": "<string>"
},
"matchData": {
"spReferenceId": "<string>",
"name": "<string>",
"strength": 123,
"givenName": "<string>",
"otherName": "<string>",
"familyName": "<string>",
"date": "<string>",
"address": "<string>",
"countries": [
{
"code": "<string>",
"matchType": "<string>"
}
],
"nationalId": {
"idNumber": "<string>",
"idType": "<string>",
"idExpiry": "<string>",
"issuingCountryCode": "<string>",
"documentId": "<string>"
},
"imageUrl": "<string>",
"isDeceased": true,
"isAlias": true,
"isRelated": true,
"gender": "MALE"
},
"aliases": [
"<string>"
],
"relatedParties": [
{
"name": "<string>",
"relationship": "<string>"
}
],
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"notes": {},
"pepData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"level": "<string>",
"sourceUrl": "<string>",
"sourcePosition": "<string>",
"position": "<string>",
"positionDescription": "<string>",
"status": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"sanctionData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"sourceUrl": "<string>",
"sourceReason": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"watchlistData": [
{
"countryCode": "<string>",
"countryName": "<string>",
"sourceName": "<string>",
"sourceUrl": "<string>",
"sourceReason": "<string>",
"listingStart": "<string>",
"listingEnd": "<string>",
"imageUrl": "<string>",
"referenceDocs": [
{
"url": "<string>",
"description": "<string>"
}
],
"additionalData": [
{
"key": "<string>",
"value": "<string>"
}
]
}
],
"mediaData": [
{
"title": "<string>",
"source": "<string>",
"snippet": "<string>",
"sourceDate": "<string>",
"sourceCountry": "<string>",
"url": "<string>",
"isCurrent": true
}
]
},
"errors": [
{
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"notes": {},
"systemStatus": "VALID",
"state": "IN_PROGRESS",
"riskFactors": [
{
"factor": "<string>",
"value": "<string>"
}
],
"updatedBy": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
}
],
"errors": [
{
"code": "<string>",
"description": "<string>",
"location": "<string>"
}
],
"notes": {},
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>"
},
"organization": {
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"createdAt": "2023-11-07T05:31:56Z",
"schemaVersion": 2,
"addresses": [
{
"country": "<string>",
"addressId": "<string>",
"sourceId": "<string>",
"type": "OTHER",
"typeDescription": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"longForm": "<string>",
"unitNumber": "<string>",
"buildingName": "<string>",
"streetName": "<string>",
"streetNumber": "<string>",
"streetType": "<string>",
"neighborhood": "<string>",
"locality": "<string>",
"district": "<string>",
"subdivision": "<string>",
"postalCode": "<string>",
"careOf": "<string>",
"status": "CURRENT",
"unstructuredLongForm": "<string>"
}
],
"phoneNumbers": [
{
"phoneNumberId": "ad165f64-5717-4562-b3fc-2c963f66bfa9",
"isPreferred": true,
"type": "MOBILE",
"sourceId": "14fd5f64-5717-4562-b3fc-2c963f66ba34",
"country": "AUS",
"number": "0426192340",
"linkedAddresses": [
{
"addressId": "fa335f64-5717-4562-b3fc-2c963f66cf41"
}
],
"unstructuredLongForm": "<string>"
}
],
"emailAddresses": [
{
"emailAddressId": "aa385f64-5717-4562-b3fc-2c963f66af21",
"type": "WORK",
"sourceId": "31dd15f64-5717-4562-b3fc-2c963f66234d",
"email": "[email protected]",
"isPreferred": true,
"linkedAddresses": [
{
"addressId": "adc215f64-5717-4562-b3fc-2c963f66222a"
}
]
}
],
"customAttributes": {},
"externalReferences": [
{
"name": "CUSTOMER-REFERENCE",
"value": "CUST-00001342",
"referenceId": "24de15f64-5717-4562-b3fc-2c963f66e23e",
"type": "CUSTOMER",
"sourceId": "93da15f64-5717-4562-b3fc-2c963f6663fe",
"description": "This is the customer ID in the core banking system."
}
],
"documents": {
"REPORT": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
},
"attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"filename": "<string>",
"mimeType": "<string>",
"pageNumber": 123,
"side": "FRONT",
"type": "<string>",
"location": "<string>",
"lastMalwareScanAt": "2023-11-07T05:31:56Z",
"retrievalStatus": "NORMAL"
}
]
}
],
"SUPPORTING": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
},
"attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"filename": "<string>",
"mimeType": "<string>",
"pageNumber": 123,
"side": "FRONT",
"type": "<string>",
"location": "<string>",
"lastMalwareScanAt": "2023-11-07T05:31:56Z",
"retrievalStatus": "NORMAL"
}
]
}
],
"IDENTITY": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
},
"attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"filename": "<string>",
"mimeType": "<string>",
"pageNumber": 123,
"side": "FRONT",
"type": "<string>",
"location": "<string>",
"lastMalwareScanAt": "2023-11-07T05:31:56Z",
"retrievalStatus": "NORMAL"
}
]
}
],
"OTHER": [
{
"type": "OTHER",
"country": "AUS",
"class": "IDENTITY",
"documentId": "92de15f64-5717-4562-b3fc-2c963f6665a7",
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"expiryDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"issueDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"primaryIdentifier": "000734130",
"secondaryIdentifier": "P0001975",
"subtype": "Photo Comparison",
"subdivision": "VIC",
"createdAt": "2024-01-15T02:18:11.365Z",
"updatedAt": "2025-01-16T02:18:11.365Z",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "324f15f64-5717-4562-b3fc-2c963f66ffa1",
"supplementaryData": {
"type": "NATIONAL_HEALTH_ID",
"reference": "1",
"nameOnCardLine1": "<string>",
"nameOnCardLine2": "<string>",
"nameOnCardLine3": "<string>",
"nameOnCardLine4": "<string>",
"middleNameOnCard": "<string>"
},
"customAttributes": {},
"attachments": [
{
"data": {
"uri": "https://s3.amazonaws.com/dev/41963bc5feff322020137de233c3be0fac6/croppedFrontID/38d54232-b840-431d-b248-152345fe214.jpg"
},
"attachmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sourceId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"filename": "<string>",
"mimeType": "<string>",
"pageNumber": 123,
"side": "FRONT",
"type": "<string>",
"location": "<string>",
"lastMalwareScanAt": "2023-11-07T05:31:56Z",
"retrievalStatus": "NORMAL"
}
]
}
]
},
"sourceId": "<string>",
"websiteUrls": [
{
"websiteUrl": "<string>",
"sourceId": "<string>"
}
],
"details": {
"type": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"class": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"subClass": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"registrationDetails": [
{
"registrationNumber": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"type": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"class": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"subClass": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"subType": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
},
"isCurrent": true,
"registeredName": {
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
},
"registeredDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"extractedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"registeredSubdivision": "<string>",
"registeredCountry": "<string>",
"registrationStatus": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
},
"registrationNumberType": "<string>",
"registrationNumberDescription": "<string>",
"updatedDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"reviewDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"foundationDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"isSuppressed": true,
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
}
],
"alternateNames": [
{
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
}
],
"name": {
"name": "<string>",
"type": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
},
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
},
"jurisdiction": {
"country": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
},
"industryDeclarations": [
{
"code": "<string>",
"description": "<string>",
"language": "<string>",
"sourceId": "<string>"
}
],
"industryCodes": [
{
"code": "<string>",
"description": "<string>",
"type": "<string>",
"sourceId": "<string>"
}
]
},
"shareholders": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"shareholderType": "<string>",
"totalShares": 123,
"totalPercentage": 123,
"shareholdings": [
{
"shareInterestType": "UNIT",
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": "<string>",
"amountDue": "<string>",
"amount": "<string>",
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
},
"percentage": 123,
"isNonBeneficiallyHeld": true,
"isJointlyHeld": true,
"holdingType": "SHARE"
}
]
}
],
"shareInterests": [
{
"shareInterestType": "UNIT",
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": "<string>",
"amountDue": "<string>",
"amount": "<string>",
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
},
"percentage": 123,
"isNonBeneficiallyHeld": true,
"isJointlyHeld": true,
"members": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"careOf": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL"
}
]
}
]
}
],
"officials": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"officialId": "<string>",
"officialType": "OFFICIAL",
"role": {
"code": "<string>",
"description": "<string>"
},
"identification": [
{
"type": "DIRECTOR_IDENTIFICATION_NUMBER",
"idNumber": "<string>",
"jurisdiction": {
"country": "<string>",
"registry": "<string>",
"registryDescription": "<string>",
"subdivision": "<string>"
}
}
],
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
},
"sourceId": "<string>",
"appointmentDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"title": "<string>",
"directorships": [
{
"organization": {
"organizationName": "<string>",
"registrationNumber": "<string>",
"organizationStatus": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
}
},
"role": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>",
"appointmentDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"nationality": "<string>"
}
],
"cessationDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"nationality": "<string>",
"countryOfResidence": "<string>",
"kind": "<string>",
"natureOfControl": [
"<string>"
],
"notifiedOn": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"shareCapital": {
"totalShareCount": 123,
"shareStructure": [
{
"shareInterestType": "UNIT",
"class": "<string>",
"classDescription": "<string>",
"shares": 123,
"nominalValue": "<string>",
"isFullyPaid": true,
"amountPaid": "<string>",
"amountDue": "<string>",
"amount": "<string>",
"unstructuredAmount": "<string>",
"currency": "<string>",
"sourceId": "<string>",
"type": "<string>",
"status": {
"normalized": {
"code": "<string>",
"description": "<string>"
},
"unstructured": {
"code": "<string>",
"description": "<string>"
},
"sourceId": "<string>"
}
}
],
"capitalType": "SHARE",
"sourceId": "<string>"
},
"indicators": [
{
"flag": "<string>",
"value": "<string>",
"indicator": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"jurisdictionalInformation": {
"registryInformation": {
"abnReplacedFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"charityInformation": [
{
"type": "<string>",
"name": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"gst": [
{
"type": "<string>",
"name": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"superannuationStatus": {
"complyingCode": "<string>",
"complyingDescription": "<string>",
"regulator": "<string>",
"exceptionMessage": "<string>"
},
"acncRegistrations": [
{
"status": "<string>",
"validFrom": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"validTo": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
}
}
],
"dgr": [
{
"dgrEntityEndorsement": "<string>",
"dgrItemNumber": "<string>"
}
],
"disclosingEntity": true,
"sourceId": "<string>"
},
"aliases": [
{
"alias": "<string>",
"sourceId": "<string>"
}
],
"vatNumber": {
"value": "<string>",
"sourceId": "<string>"
},
"virtualId": {
"value": "<string>",
"sourceId": "<string>"
},
"fiscalCode": {
"code": "<string>",
"description": "<string>",
"sourceId": "<string>"
},
"legalFormDetails": {
"basis": "<string>",
"capital": "<string>",
"comments": "<string>",
"control": "<string>",
"incorp": "<string>",
"partner": "<string>",
"responsibility": "<string>",
"stocks": "<string>",
"sourceId": "<string>"
},
"annualAccount": {
"lastAnnualAccountDate": {
"year": "1990",
"month": "03",
"day": "27",
"unstructured": "12 Rajab 1445 AH",
"type": "GREGORIAN",
"normalized": "1990-03-31"
},
"sourceId": "<string>"
}
},
"updatedAt": "2023-11-07T05:31:56Z",
"linkedIndividuals": {},
"linkedOrganizations": {},
"linkedUnknownEntities": {},
"blockingEntities": {},
"ultimateBeneficialOwners": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"percentageOwned": {
"total": 123,
"isTotalNearZero": true,
"beneficially": 123,
"isBeneficialNearZero": true,
"nonBeneficially": 123,
"isNonBeneficialNearZero": true,
"isContainingJointOwnership": true
},
"reasons": [
{
"code": "<string>",
"description": "<string>"
}
],
"sourceId": "<string>"
}
],
"otherOwners": [
{
"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"entityType": "INDIVIDUAL",
"percentageOwned": {
"total": 123,
"isTotalNearZero": true,
"beneficially": 123,
"isBeneficialNearZero": true,
"nonBeneficially": 123,
"isNonBeneficialNearZero": true,
"isContainingJointOwnership": true
},
"sourceId": "<string>"
}
],
"informationSources": {},
"ownershipPolicy": {
"uboThreshold": 123,
"blockingThreshold": 123,
"blockingDefinitions": [
"ORGANIZATION_NOT_FOUND"
]
}
}
}

Authorizations

api_key
string
header
required

Headers

api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

X-Frankie-Channel
string

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.

X-Frankie-Username
string

Username provided by API caller

Path Parameters

entityId
string
required

Unique FrankieOne identifier for an entity

serviceName
string
required

The unique name of the service profile

workflowName
string
required

The unique name of the workflow

workflowExecutionId
string
required

Unique workflow execution identifier

Response

Workflow has completed

requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

workflowResult
object

Summary of the workflow execution.

Using and interpreting the status field

The result of the workflow is represented in the status field. Users can manually override this status with a different value to change the outcome of the workflow. When the status field is overridden, the statusOverrideRequestId field is populated with the request ID of the override request. If the statusOverrideRequestId field is present and non-empty, it indicates that the status has been manually changed.

  1. Initial State:
    • When a workflow completes, its result is set in the status field.
  2. Status Override:
    • Users may override the status field with a different value (e.g., change FAIL to PASS).
  3. Identifying Overrides:
    • To determine if a status has been overridden, check for the presence of the statusOverrideRequestId field.
    • If present, it indicates that the status has been manually changed.
  4. Additional Override Information:
    • statusOverrideBy: Identifies the user who performed the override (may not always be present).
    • statusOverrideAt: Timestamp of when the override occurred.
  5. Interpretation:
    • If statusOverrideRequestId is empty or absent, no override has occurred.
    • If statusOverrideRequestId is present, then a manual override has occurred.
organization
object

Organization details at the current time. This could be different from the original organization details at the time of workflow execution.