------ This API allows developers to integrate the Frankie Financial Compliance Utility into their applications. The API allows: - Checking name, address, date of birth against national databases - Validating Australian driver's licences, passports, medicare, visas and other Australian nationa
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.demo.frankiefinancial.io/compliance/v1.2
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
------ This API allows developers to integrate the Frankie Financial Compliance Utility into their applications. The API allows: - Checking name, address, date of birth against national databases - Validating Australian driver's licences, passports, medicare, visas and other Australian national ID documents - Validating Australian electricity bills - Validating NZ driver's licences - V
| method | path | what the vendor says it does |
|---|---|---|
POST | /business/international/profile | Retrieve a business profile from any country (AUS included). Using the Company Code retrieved from the search |
POST | /business/international/search | Search for a business from any country (AUS included). Search for a given business name or business number acr |
POST | /business/ownership/query | Create Business Entity and Query UBO (AUS Only) Process a request for ownership details for an Australian orga |
POST | /business/reports | Run Report(s) against a new or existing organisation entity (AUS Only). NOTE: Australian companies ONLY. Creat |
POST | /business/{entityId}/verify | Run KYC/AML Checks on Organisation and/or Associated Individuals. Run KYC/AML for a selection of entities asso |
POST | /document | Create New Document. Create a document object. A document object can be used to simply store data around a giv |
POST | /document/new/compare | Create Document and Compare to Original. Creates a new document from the "toDocument" parameter (usual rules a |
POST | /document/new/scan | Create and OCR Scan Document. Create a document object. This is then processed to extract useful information a |
POST | /document/new/utility/process/compare | Create Document and Run Utility Price Comparison. Create a document object. This is then processed to extract |
POST | /document/new/verify | Create and Verify Document. Send the document to an external service to have the detailed verified. For examp |
POST | /document/search | Search For a Document !! EXPERIMENTAL !! Search for an existing document that matches the criteria supplied T |
GET | /document/{documentId} | Retrieve Document Details Query the current status and details of a given documentId. Document |
POST | /document/{documentId} | Update Existing Document. Using a previously uploaded but incomplete document, you can optionally supply updat |
DELETE | /document/{documentId} | Delete Document. Mark this document as deleted. It will then become effectively invisible to all queries, but |
GET | /document/{documentId}/checks | Retrieve Document Verification Check Details. Get the complete list of all checks that have been performed upo |
POST | /document/{documentId}/compare | Update Document and Compare to Original. Send the attached document scans to an external service for processin |
GET | /document/{documentId}/full | Retrieve Document and Scan Data Query the current status and details of a given documentId. Also returns all d |
POST | /document/{documentId}/scan | Update and OCR Scan Document Using a previously uploaded but potentially incomplete document, you can optional |
POST | /document/{documentId}/utility/process/compare | Update Document and Run Utility Price Comparison. Using a previously uploaded but incomplete document, you can |
POST | /document/{documentId}/utility/process/consent | Provide Explicit Consent to Switch Utility Plans. Using a previously uploaded and processed document, the user |
POST | /document/{documentId}/utility/process/switch | Initiate Switching of Utility Plan. Using a previously uploaded and processed document, the user must provide |
POST | /document/{documentId}/verify | Update and Verify Document. Using a previously uploaded but potentially incomplete document, you can optionall |
POST | /entity | Create New Entity. Create an entity object. An entity object can be used to simply store data around a given i |
POST | /entity/new/idvalidate/getToken | Create Entity and Get IDV Token Create an entity object and if successful, obtain a token for use in an ID Val |
POST | /entity/new/verify/pushToMobile | Create Entity and Push Self-Verification Link Create an entity object and begin the process of verification af |
POST | /entity/new/verify/{checkType}/{resultLevel} | Create and Verify Entity Create an entity object. An entity object can be used to simply store data around a g |
POST | /entity/search | Search for Entity Search for an existing entity that matches the criteria supplied Criteria are supplied in t |
GET | /entity/{entityId} | Retrieve Entity Details Query the current status and details of a given entityId. Entity |
POST | /entity/{entityId} | Update Existing Entity. Using a previously uploaded but incomplete Entity, you can optionally supply updated d |
DELETE | /entity/{entityId} | Delete Entity Marks the entity as deleted in the system, and no further operations or general queries may be e |
POST | /entity/{entityId}/check/{checkId}/{checkClass} | Update Check Result States (Batch) Internal only Update a given set of KYC and/or AML check result statuses i |
POST | /entity/{entityId}/check/{checkId}/{checkClass}/{checkClassId} | Update Check Result State Internal only Update a given KYC or AML check result status in order to force a re- |
GET | /entity/{entityId}/checks | Retrieve Entity Verication Check Details Get the complete list of all checks that have been performed upon a g |
POST | /entity/{entityId}/flag/blacklist | Set Entity Blacklist State. Mark the entity as blacklisted or not with the '?set=' query parameter as 'true' o |
POST | /entity/{entityId}/flag/duplicate/{otherId} | Resolve Duplicate States. Resolve the state of a pair of duplicate entities with the '?set=' query parameter a |
POST | /entity/{entityId}/flag/monitor | Set Entity Ongoing AML Monitoring Status. Mark the entity as being monitored or not with the '?set=' query par |
POST | /entity/{entityId}/flag/watchlist | Set Entity Watchlist State. Mark the entity as watchlisted or not with the '?set=' query parameter as 'true' o |
GET | /entity/{entityId}/full | Retrieve Entity Details and Document Scan Data Query the current status and details of a given entityId. Also |
POST | /entity/{entityId}/idvalidate/getToken | Update Entity and Get IDV Token Update an entity object and if successful, obtain a token for use in an ID Val |
POST | /entity/{entityId}/idvalidate/initProcess | Update Entity and Initiate IDV Process Update an entity object and if successful, start the process of downloa |
and 6 more operation(s) in this specification, all searchable.
specification origin: https://app.swaggerhub.com/apiproxy/registry/FrankieFinancial/kycutility/1.5.3
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.