KYC API EndpointsBusiness

(AUS Only) Run Report(s) against a new or existing organisation entity and produce a PDF formatted document.

NOTE: Australian companies ONLY. Create or find and update an ORGANISATION type entity, then run the requested reports. Reports include: - Credit Report - Credit Score - Payment Predictor 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. If a PDF report is requested then that report will be generated over time, so a temporary response with only the JSON reports will be returned and a webhook notification will be pushed later once the PDF report has been completed.

Authentication

api_keystring
API Key authentication via header

Headers

X-Frankie-CustomerIDstringRequiredformat: "uuid"
Customer ID issued by Frankie Financial. This will never change. Your API key, which is mapped to this identity, will change over time.
X-Frankie-CustomerChildIDstringOptionalformat: "uuid"
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.
X-Frankie-ChannelstringOptional
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.

Query parameters

reportTypesstringRequired
Define the report(s) you wish to run. You can request more than one as a comma separated list. Duplicates will be ignored. Note: These reports are different to the business details and UBO queries and are meant to provide deeper detail and background on a business or organisation. Current valid report types are: - creditScore - creditReport - paymentPredictor
pdfbooleanOptional

Should the report(s) also be generated as a PDF document.

Request

The organisation to be queried. An entity object that must have be an ORGANISATION type with at least one organisation number (ABN or ACN).

addresseslist of objectsOptional
Collection of address objects.
dateOfBirthobjectOptional
entityIdstringOptionalformat: "uuid"

When an entity is first created, it is assigned an ID. When updating an entity, make sure you set the entityId One exception to this is when an entity is created from a document object. It is expected that this object would be passed into a /check or /entity call to set it.

entityProfilestringOptional

If the entity is using the new profiles feature, then their profile name will be found here.

Note: If setting a profile, you must ensure that the profile matches a known configuration.

See here for valid values: https://docs.frankieone.com/docs/test-entity-verification

entityTypeenumOptional
Indicates the type of an entity. - "INDIVIDUAL": An individual. - "TRUST": A trust. - "ORGANISATION": An organisation.
Allowed values:
extraDatalist of objectsOptional
Set of key-value pairs that provide arbitrary additional type-specific data. You can use these fields to store external IDs, or other non-identity related items if you need to. If updating an existing entity, then existing values with the same name will be overwritten. New values will be added. See here for more information about possible values you can use: https://docs.frankieone.com/docs/key-value-pairs
flagslist of objectsOptional

Used to set additional information flags with regards to this entity and for ongoing processing.

Flags might include having the entity (not) participate in regular pep/sanctions screening Others will follow over time.

genderenumOptional
Used to indicate of the entity in question is: - "M"ale - "F"emale - "U"nspecified - "O"ther (for want of a better option)
Allowed values:
identityDocslist of objectsOptional

Collection of identity documents (photos, scans, selfies, etc)

nameobjectOptional
organisationDataobjectOptional
Organisation details for entities. Returned from an ASIC report.

Response

The request was valid and was successfully processed. The report was run and the results have been attached.
checkIdstring or nullformat: "uuid"
Unique Frankie identifier for the report operation.
entityobject or null
Describes all of the data being used to verify an entity.
providerCheckIdstring or null
Unique identifier provided by the service.
reportslist of objects or null
The collection of requested business reports.
requestIdstring or nullformat: "ulid"

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.

Errors