Frankie Financial API
------ This API allows developers to integrate the Frankie Financial Compliance Utility into their applications. The API allows: Checking name, address, date…
Finance & banking#openapi#financial
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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
- Validating Chinese bank cards and national ID card
- Validating International passports and national ID documents
- PEP, Sanctions, Watchlist and adverse media checking
- Australian visa checks
- Fraud list and fraud background checks
- ID validation and selfie check comparisons.
Industry specific services
- Comparing Australian electricity retailers for a better deal.
KYB specific services
- Query organisation ownership
- Perform KYC & AML checks on shareholders, beneficial owners and office bearers.
- Query credit score and credit reports
- International company searches
- International company profiles
The full version of this documentation along with supplemental articles can be found here:
- https://apidocs.frankiefinancial.com/
The traditional Swagger view of this documentation can be found here:
- https://app.swaggerhub.com/apis-docs/FrankieFinancial/kycutility
Sandbox base URL is:
- https://api.demo.frankiefinancial.io/compliance/v1.2
- We do have an old sandbox at https://sandbox.frankiefinancial.com/compliance/v1.2 but this has been retired.
- All calls are the same as production, only with canned data.
- Full Swagger definition, along with test data for playing in the sandbox can be obtained once initial commercial discussions have commenced.
- Production and optional UAT access will be opened up only to those with a signed commercial contract.
Contact us at hello@frankiefinancial.com to speak with a sales rep about issuing a Customer ID and Sandbox api key.
Endpoints 46
Status
- GETService Status
/ruok?askingNicely=trueSimple check to see if the service is running smoothly.
Document
- POSTCreate New Document.
/documentCreate a document object. A document object can be used to simply store data around a given identity or similar document. You can attach scans, PDFs, photos,… - POSTCreate Document and Compare to Original.
/document/new/compareCreates a new document from the "toDocument" parameter (usual rules apply in that it must be a valid document, with no existing documentId). The… - POSTCreate and OCR Scan Document.
/document/new/scanCreate a document object. This is then processed to extract useful information and create an entity; or it may be attached to an entity, either directly or… - POSTCreate and Verify Document.
/document/new/verifySend the document to an external service to have the detailed verified. For example, we could send through the details of a drivers licence to be checked… - POSTSearch For a Document !! EXPERIMENTAL !!
/document/searchSearch for an existing document that matches the criteria supplied There are of course limits to what can be searched upon. For a document search to work, you… - GETRetrieve Document Details
/document/:documentIdQuery the current status and details of a given documentId. - POSTUpdate Existing Document.
/document/:documentId?noInvalidate=trueUsing a previously uploaded but incomplete document, you can optionally supply updated details (such as corrections on a previous scan), along with one or… - DELETEDelete Document.
/document/:documentIdMark this document as deleted. It will then become effectively invisible to all queries, but will be available in anonymised form for a past check. - GETRetrieve Document Verification Check Details.
/document/:documentId/checksGet the complete list of all checks that have been performed upon a given document, including the checks that have been performed by others (in those cases… - POSTUpdate Document and Compare to Original.
/document/:documentId/compareSend the attached document scans to an external service for processing and comparison, such as comparing a selfie-video against a drivers licence photo. *… - GETRetrieve Document and Scan Data
/document/:documentId/fullQuery the current status and details of a given documentId. Also returns all document file data, not just the metadata. - POSTUpdate and OCR Scan Document
/document/:documentId/scanUsing a previously uploaded but potentially incomplete document, you can optionally supply updated details (such as corrections on a previous scan), along… - POSTUpdate and Verify Document.
/document/:documentId/verifyUsing a previously uploaded but potentially incomplete document, you can optionally supply updated details (such as corrections on a previous scan), along…
Entity
- POSTCreate New Entity.
/entityCreate an entity object. An entity object can be used to simply store data around a given identity. You can attach ID documents, scans, PDFs, photos, videos,… - POSTCreate Entity and Get IDV Token
/entity/new/idvalidate/getTokenCreate an entity object and if successful, obtain a token for use in an ID Validation service SDK (web or native app) At a minimum, you will need to supply:… - POSTCreate Entity and Push Self-Verification Link
/entity/new/verify/pushToMobile?nopush=trueCreate an entity object and begin the process of verification after pushing a message to a mobile number. The entity will receive a link on their mobile and… - POSTCreate and Verify Entity
/entity/new/verify/:checkType/:resultLevelCreate an entity object. An entity object can be used to simply store data around a given identity. You can attach ID documents, scans, PDFs, photos, videos,… - POSTSearch for Entity
/entity/searchSearch for an existing entity that matches the criteria supplied Criteria are supplied in the form of a populated entity object, with the name/address/DoB… - GETRetrieve Entity Details
/entity/:entityIdQuery the current status and details of a given entityId. - POSTUpdate Existing Entity.
/entity/:entityId?noInvalidate=trueUsing a previously uploaded but incomplete Entity, you can optionally supply updated details (such as corrections on a previous address), along with one or… - DELETEDelete Entity
/entity/:entityIdMarks the entity as deleted in the system, and no further operations or general queries may be executed against it by the Customer. If another customer is… - POSTUpdate Check Result States (Batch)
/entity/:entityId/check/:checkId/:checkClassInternal only Update a given set of KYC and/or AML check result statuses in order to force a re-evaluation of the overall check result. - POSTUpdate Check Result State
/entity/:entityId/check/:checkId/:checkClass/:checkClassId?status=string&undo=trueInternal only Update a given KYC or AML check result status in order to force a re-evaluation of the overall check result. - GETRetrieve Entity Verication Check Details
/entity/:entityId/checks?alldata=trueGet the complete list of all checks that have been performed upon a given entity and its documents, including the checks that have been performed by others… - GETRetrieve Entity Details and Document Scan Data
/entity/:entityId/fullQuery the current status and details of a given entityId. Also returns all attached document file data, not just the metadata. Equivalent to a get… - POSTUpdate Entity and Get IDV Token
/entity/:entityId/idvalidate/getTokenUpdate an entity object and if successful, obtain a token for use in an ID Validation service SDK (web or native app) At a minimum, the entity will need to… - POSTUpdate Entity and Initiate IDV Process
/entity/:entityId/idvalidate/initProcessUpdate an entity object and if successful, start the process of downloading the captured data and processing the reports and results of the ID validation… - POSTUpdate Entity States
/entity/:entityId/status?set=wait&risk=low&comment=stringInternal only Add a special internal 'entity result' to superceed any previous real checks until the next one. - POSTUpdate Entity and Push Self-Verification Link
/entity/:entityId/verify/pushToMobile?nopush=true&phase=0Update an existing entity object and begin the process of verification after pushing a message to a mobile number. The entity will receive a link on their… - POSTUpdate Entity and Verify Details
/entity/:entityId/verify/:checkType/:resultLevel?force=true&noInvalidate=trueTake the details and documents provided in the entity, and set about verifying them all. So for example, you might extract: * The name from the entity.name…
Business
- POSTRetrieve a business profile from any country (AUS included).
/business/international/profileUsing the Company Code retrieved from the search response (see above) you can pull back the details of the company. The Frankie platform will save the details… - POSTSearch for a business from any country (AUS included).
/business/international/searchSearch for a given business name or business number across international business registers. The search will return a list of matching companies that you can… - POSTCreate Business Entity and Query UBO (AUS Only)
/business/ownership/query?checkType=full&entityCategories=organisation&resultLevel=summary&validation=on&generateReport=string&includeHistorical=true&onlyProfile=trueProcess a request for ownership details for an Australian organisation. See below for more generic international queries. At a minimum, you just need to… - POSTRun Report(s) against a new or existing organisation entity (AUS Only).
/business/reports?reportTypes=stringNOTE: Australian companies ONLY. Create or find and update an ORGANISATION type entity, then run the requested reports. Reports include: Credit Report Credit… - POSTRun KYC/AML Checks on Organisation and/or Associated Individuals.
/business/:entityId/verify?checkType=full&entityCategories=organisation&resultLevel=summary&generateReport=stringRun KYC/AML for a selection of entities associated with an organisation and/or the organisation itself based on a previous ownership query. By default AML…
Industry
- POSTCreate Document and Run Utility Price Comparison.
/document/new/utility/process/compare?planLimit=30Create a document object. This is then processed to extract useful information, just like a normal OCR scan. The service will then push the document through… - POSTUpdate Document and Run Utility Price Comparison.
/document/:documentId/utility/process/compare?planLimit=30Using a previously uploaded but incomplete document, you can optionally supply updated details or simply request that the document be re-processed through the… - POSTProvide Explicit Consent to Switch Utility Plans.
/document/:documentId/utility/process/consentUsing a previously uploaded and processed document, the user must provide explicit consent before being able to call the /switch function. Before entering… - POSTInitiate Switching of Utility Plan.
/document/:documentId/utility/process/switchUsing a previously uploaded and processed document, the user must provide explicit consent before being able to call the /switch function. The bill payer has…
Push Notification
- POSTPush Notification Payload
/your/configured/path/:requestIdWhenever you request that a transaction be put into the background, there needs to be a mechanism for notifying you that the request has been completed. This…
Retrieve
- GET(Re)retrieve Response Result.
/retrieve/response/:requestId?payload=stringIf you've received a notification that you previously backgrounded transaction has completed, or you wish to re-retrive a result from an earlier transaction,…
Flag
- POSTSet Entity Blacklist State.
/entity/:entityId/flag/blacklist?set=true&reason=string&blockedBy=string&attribute=string&originalId=stringMark the entity as blacklisted or not with the '?set=' query parameter as 'true' or 'false'. - POSTResolve Duplicate States.
/entity/:entityId/flag/duplicate/:otherId?set=trueResolve the state of a pair of duplicate entities with the '?set=' query parameter as 'true' or 'false'. Setting duplicate to 'true' will make entityId… - POSTSet Entity Ongoing AML Monitoring Status.
/entity/:entityId/flag/monitor?set=trueMark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'. - POSTSet Entity Watchlist State.
/entity/:entityId/flag/watchlist?set=true&reason=string&comment=stringMark the entity as watchlisted or not with the '?set=' query parameter as 'true' or 'false'.
API details
- Base URL
https://api.demo.frankiefinancial.io/compliance/v1.2- Authentication
- An API key in the api_key header
- Operations
- 46 operations on 42 pathsPOST 36GET 8DELETE 2
- Main resources
- Entity 17Document 13Business 5Flag 4Industry 4Push Notification 1Retrieve 1Status 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.5.3 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Frankie Financial API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Frankie Financial API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the api_key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Service Status” (GET /ruok?askingNicely=true), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Frankie Financial API?
------ This API allows developers to integrate the Frankie Financial Compliance Utility into their applications. The API allows: Checking name, address, date… It is listed under Finance & banking and has 46 endpoints.
Who publishes the Frankie Financial API?
It is listed from Frankiefinancial's public API description (an OpenAPI document), not published by Frankiefinancial on Swastik Codes. Anyone who controls frankiefinancial.io can claim the profile by adding a DNS TXT record.
What is the base URL of the Frankie Financial API?
Requests go to https://api.demo.frankiefinancial.io/compliance/v1.2. Endpoint paths are added to this base URL.
How do I authenticate with the Frankie Financial API?
With an API key in the api_key header.
How many endpoints does the Frankie Financial API have?
46 operations on 42 paths (36 POST, 8 GET, 2 DELETE). The largest groups are Entity, Document, Business, Flag.
Is forking the Frankie Financial API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.