KYC API EndpointsBusiness

(AUS Only) Retrieve previous UBO query results

Retrieve results from a previous UBO query along with the current KYC/AML results (if any) for associated entities. *NOTE:* This will only return check details for an Australian Organisation that has previously called one of the following calls: * Create Business and Query UBO call (https://apidocs.frankiefinancial.com/reference/businessownershipquery) or * Run KYC/AML Checks on Organisation (https://apidocs.frankiefinancial.com/reference/checkorganisation) More details on how to use this API and interpret the results can be found here: https://apidocs.frankiefinancial.com/docs/australian-business-function-overview

Authentication

api_keystring
API Key authentication via header

Path parameters

entityIdstringRequiredformat: "uuid"

The entityId returned previously from an earlier call to /check or /entity

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

documentDataenumOptionalDefaults to full
The type of data to return. Default is 'full'.
Allowed values:

Response

This is what you will find in the payload of a retrieved response should the ownership query succeed, or you’re querying the past checks for a given business.

NOTE: When requesting the initial report, you will only ever receive a 202 response.

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.

ownershipCheckIdstring or nullformat: "uuid"
Unique identifier for the ownership check.
ownershipCheckDatestring or nullformat: "date-time"
If an ownership result is provided in this response then this is the date and time the service provided that result.
organisationCheckIdstring or nullformat: "uuid"

Batch identifier for the KYC/AML check results if any.

uboResponseobject or null
ownershipQueryResultobject or null
organisationCheckResultobject or null

The results of KYC/AML check on a organisation with a prior ownership query. This will be retrived via GET /retrieve/response/{requestId} after you receive a notification that the results are ready.

ownershipQueryErrorobject or null
flagslist of objects or null
Used to set additional information flags for this response.
reportResultobject or null
The positive result of a report generation request if any.
reportErrorobject or null

Errors