If you've received a notification that you previously backgrounded transaction has completed, or you wish to re-retrive a result from an earlier transaction, then you can simply request the result from our encrypted cache The response will return the original HTTP code, along with the payload that would have been returned in the original request.
Create 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 through an ID check. The service will attempt to extract relevant data from any/all uploaded images/documents and will place those in the extraData KVP block.
Send 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 against a national database. * NOTE: This is NOT the OCR data extraction process (see /document/scan) * NOTE: This is NOT the comparison process (see /document/compare)
Create 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, etc to the entity if you wish and these may be processed later (using the /scan function) to extract useful information. Or you can manually supply the information if you choose. If the entity is successfully created, take the details and documents provided, and set about verifying them all. So for example, you might extract: * The name from the entity.name object * The address from the entity.address object * The DoB.. All documents that are attached to the entity will also be verified (if possible). You can also specify the level of detail returned using the resultLevel parameter. You can choose "summary" or "full". For the "profile" check type you can also select "simple" to only get the entity profile result. SPECIAL NOTE: A "Full" response includes details of all checks and how they map against each element, along with all the details of pep/sanctions/etc checks too. Your account also needs to be configured to support a full response too (talk to your account manager for more information). If you're not configured for full responses, we'll only return summary level data regardless.
Process a request for ownership details for an Australian organisation. See below for more generic international queries. At a minimum, you just need to supply an ACN or ABN and we can retrieve the rest. You also have the option of supplying company name, type (as per ABR types) and both ABN/ACN and we'll attempt to verfy that that data matches what is on record before attempting any further verification and validation. KYC/AML for a selection of entities associated with an organisation and/or the organisation itself can optionally be run, but not by default. To enable KYC/AML checks one or more entity categories must be provided. If such a list of entity categories is given then default checks based on configuration will be run for those categories. If a check type is also provided in the request then that type will be used for entities representing individual entities, and the AML subset of that check will be used for organisations if any. Specifying a check type without an entity category will result in an error. NOTE: This query will always run asynchronously and you will only ever be returned a 202 ACCEPT response, or an error. Results will be pushed using the Push Notification API below and you will be able to retrieve the results using the Retrieve API. We have supplied the 200 response in the definition below only so what will be sent to you when you later retrieve the details. More details on how to use this API and interpret the results can be found here: https://apidocs.frankiefinancial.com/docs/which-function-to-use
Creates a new document from the "toDocument" parameter (usual rules apply in that it must be a valid document, with no existing documentId). The compareDocument can be an existing documentId, or it too can be new as well. * If existing (i.e. a valid DocumentId is supplied), it will be updated with any new data supplied before being sent to the comparison process. * If new, then a new document will be created too, and the ID returned in the result. The document scans are then sent for processing and comparison, such as comparing a selfie-video against a drivers licence photo. * NOTE: This is NOT the verification process (see /document/verify) * NOTE: This is NOT the OCR data extraction process either (see /document/scan)
Create 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 an industry specific comparison process, where the details are used to find a better plan, based on the bill. 100's of datapoints are accurately extracted from the uploaded document. This data is then used to compare the bill against the whole market. A personalised comparison is returned that is a best fit for the customer's energy profile. * NOTE: It is expected that the type of document being uploaded will be a PDF and the idType is UTILITY_BILL. (These values will be set automatically if not supplied). You can optionally include the utility name (e.g. Origin Energy) in the idSubType if you wish.
Create 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 will then be guided through a series of steps to capture and OCR scan their ID, and perform a selfie comparison. We'll then attempt to verify the data received and push a notification back to the calling customer. At a minimum, you will need to supply the name and a MOBILE_PHONE document type. SPECIAL NOTE: This will only ever return a 202 response if successfully accepted. You will need to ensure your account is configured for push notifications. Contact developer supprt to arrange this.
Create 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, videos, etc to the objectif you wish and these may be processed later (using the /scan function) to extract useful information. Or you can manually supply the extracted information if you choose. Document objects can be used to create an entity, based on extracted or supplied data; or it may be attached to an existing entity, either directly or through an ID check.
Create 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, etc to the entity if you wish and these may be processed later (using the /scan function) to extract useful information. Or you can manually supply the information if you choose. Entity objects can be used to run a check, using the data held in the records.
Mark this document as deleted. It will then become effectively invisible to all queries, but will be available in anonymised form for a past check.
Marks 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 presently relying on this data, it will still be available to them (but only in the partially anonymised form they originally had. An entity and its related data is only completely deleted from the database when either: - a) There are no more references to it (i.e. it has been DELETEd by all Customers relying on the data), and 12 months have passed. - b) The actual consumer who owns the data makes a direct request. If this occurs, then all subscribing Customers will be notified that this entity has been removed and they will need to contact them if needed in order to update their own records again.
Using a previously uploaded and processed document, the user must provide explicit consent before being able to call the /switch function. The bill payer has uploaded their current bill, selected a new plan, accepted the terms and conditions and given their consent for the switch to occur. This API call will finalise the switch request and send all the customers data along with the requested plan to the selected retailer. * NOTE: as part of this call, you must provide a previously returned corellationId that is associated with this document and the returned plan options. Failure to do so will result in an error response.
Using a previously uploaded and processed document, the user must provide explicit consent before being able to call the /switch function. Before entering into a contract with a new energy retailer, consumers are first obliged to review the retailer's contractual terms and conditions, confirm they understand these terms as well as give explicit, informed consent (EIC) for the switch to occur. This API call retrieves all information that must be displayed in order for a compliant EIC to be captured from a consumer. * NOTE: as part of this call, you must provide a previously returned corellationId that is associated with this document and the returned plan options. Failure to do so will result in an error response.
Whenever 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 notification will push you the high-level details of the result, and you can then query the results at your leisiure. The same notification process will also be used to push alerts to your system. This means that RequestIDs may not match your records
Resolve the state of a pair of duplicate entities with the '?set=' query parameter as 'true' or 'false'. Setting duplicate to 'true' will make entityId invisible for most purposes and otherId will continue to function as normal. Setting duplicate to 'false' means the two entities are in fact separate but similar and they will both continue to exist independently but will no longer be identified as duplicates of eachother.
Using 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 of the response as an ORGANISATION type entity with the profile attached as a report which you can potentially re-retrieve later if you wish.
Query the current status and details of a given documentId. Also returns all document file data, not just the metadata.
Query the current status and details of a given documentId.
Get 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 you just get the id, status and date run, none of the details).
Query the current status and details of a given entityId.
Query the current status and details of a given entityId. Also returns all attached document file data, not just the metadata. Equivalent to a get /document/{documentId}/full)
Get 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 (in those cases you just get the id, status and date run, none of the details).
Run 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 will be checked for just the organisation itself. If a list of entity categories is given then default checks based on configuration will be run for those categories. If a check type is also provided in the request then that type will be used for entities representing individual entities, and the AML subset of that check will be used for organisations if any. If no ownership query has been run, then this operation will return an error.
NOTE: Australian companies ONLY. Create or find and update an ORGANISATION type entity, then run the requested reports. Reports include: - Credit Report - Credit Score At a minimum, you just need to supply an ACN and/or ABN and an entity type set to ORGANISATION. Alternatively the entity ID of an existing ORGANISATION entity gan be given in the request body Note: these reports are different to the Ultimate Beneficial Owner and Business Detail requests - these reports are independent data and analysis over and above company information and verification details. You can request multiple reports to be run at once and they will be returned as a group (where feasible). If a report can only be generated over time, then a temporary response will be returned and a webhook notification will be pushed later once the report has been completed.
Search for a given business name or business number across international business registers. The search will return a list of matching companies that you can then potentially query using the international profile query (see below). Each search result will have a CompanyCode that you use to retrieve the specific company details using the profile function. This process will not save any details from the search results.
Search 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 must supply at a minimum: * idType * country * idNumber The service will return a list of matching documents with confidence levels. If you are the "owner" of the document - i.e. the same CustomerID and CustomerChildID (if relevant) - then the full details of the document will be returned, except for the contents of any attached scans. If you are not the owner of the document, then just the ID and confidence level is returned. You can still use this ID to retrieve any check results (see GET /document/{documentId}/checks) Note: At this time, we cannot perform searches on document scans. But, you can supply extraData KVPs if they're known. These will help doublecheck search results with ambiguous results.
Search 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 details supplied. You can also include documents that can be used to further refine your search (see the /document/search function for minimum requirements for a document search) At an absolute minimum, you must supply one of the following combinations: * name.familyName + * name.givenNames or * name.familyName + * one identityDocument object (that meets minimum criteria) Obviously, the more data you provide, the better search results we can provide. The service will return a list of matching entities with confidence levels. If you are the "owner" of the entity - i.e. the same CustomerID and CustomerChildID (if relevant) - then the full details of the entity and any owned documents will be returned, except for the contents of any attached scans. If you are not the owner of the entity (or linked documents), then just the ID and confidence level is returned. You can still use this ID to retrieve any check results (see GET /entity/{entityId}/checks and GET /document/{documentId}/checks) Note: This functionality must be enabled by Frankie administrators. Please contact your sales representative if you wish to discuss this.
Simple check to see if the service is running smoothly.
Mark the entity as blacklisted or not with the '?set=' query parameter as 'true' or 'false'.
Mark the entity as being monitored or not with the '?set=' query parameter as 'true' or 'false'.
Mark the entity as watchlisted or not with the '?set=' query parameter as 'true' or 'false'.
Using a previously uploaded but potentially incomplete document, you can optionally supply updated details (such as corrections on a previous scan), along with one or more additional ID scans (e.g. additional pages). Includes a follow-on action as well initiating OCR processing proceedures immediately. The service will attempt to extract relevant data from any/all uploaded images/documents and will place those in the extraData KVP block.
Using a previously uploaded but potentially incomplete document, you can optionally supply updated details (such as corrections on a previous scan), along with one or more additional ID scans (e.g. additional pages). Includes a follow-on action as well initiating verification proceedures immediately. Sends the updated 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 against a national database. * NOTE: This is NOT the OCR data extraction process (see /document/scan) * NOTE: This is NOT the comparison process (see /document/compare)
Internal only Update a given KYC or AML check result status in order to force a re-evaluation of the overall check result.
Send the attached document scans to an external service for processing and comparison, such as comparing a selfie-video against a drivers licence photo. * NOTE: This is NOT the verification process (see /document/verify) * NOTE: This is NOT the OCR data extraction process either (see /document/scan)
Using a previously uploaded but incomplete document, you can optionally supply updated details or simply request that the document be re-processed through the industry comparison service. 100's of datapoints are accurately extracted from the uploaded document. This data is then used to compare the bill against the whole market. A personalised comparison is returned that is a best fit for the customer's energy profile. * NOTE: It is expected that the type of document being uploaded will be a PDF and the idType is UTILITY_BILL. (These values will be set automatically if not supplied). You can optionally include the utility name (e.g. Origin Energy) in the idSubType if you wish.
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.
Update 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 mobile and will then be guided through a series of steps to capture and OCR scan their ID, and perform a selfie comparison. We'll then attempt to verify the data received and push a notification back to the calling customer. At a minimum, you will need to supply the name and a MOBILE_PHONE document type. If you wish to skip the detail capture and jump straight to the ID and selfie capture, the append the call with the ?phase=2 parameter. SPECIAL NOTE: This will only ever return a 202 response if successfully accepted. You will need to ensure your account is configured for push notifications. Contact developer supprt to arrange this.
Take 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 object * The address from the entity.address object * The DoB.. All documents that are presently attached to the entity will also be verified (if requested) You can also specify the level of detail returned using the resultLevel parameter. You can choose "summary" or "full". For the "profile" check type you can also select "simple" to only get the entity profile result. SPECIAL NOTE: A "Full" response includes details of all checks and how they map against each element, along with all the details of pep/sanctions/etc checks too. Your account also needs to be configured to support a full response too (talk to your account manager for more information). If you're not configured for full responses, we'll only return summary level data regardless.
Internal only Add a special internal 'entity result' to superceed any previous real checks until the next one.
Using a previously uploaded but incomplete document, you can optionally supply updated details (such as corrections on a previous scan), along with one or more additional ID scans (e.g. additional pages).
Using a previously uploaded but incomplete Entity, you can optionally supply updated details (such as corrections on a previous address), along with one or more additional ID docs/scans (e.g. new documents to parse, etc).
Tell us which provider you need, and we will ship it in the registry.
Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.