KYC API EndpointsBusiness

(AUS Only) Make an existing entity (otherId) a direct associated entity of a parent organisation (entityId), or update an existing association.

Update an entity with the provided details, then associated it with a parent organisation, or update any existing association. To use an existing entity, and not update it, either omit the entity field, use null, or just provide an entity object that contains only the entity ID, which must match the one given in the request URL. At least the entity name (family name for individuals, registered name for organisations) must be present in the entity after any update. The referenced parent entity must be of type ORGANISATION and an ownership query must have been previously completed. At least one of role or percentage held must be in the request. If either is null or omitted, then any existing details will be retained. If either detail is given, the it will be replaced, not merged.

Path parameters

entityIdstringRequiredformat: "uuid"

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

otherIdstringRequiredformat: "uuid"

An entityId returned previously from an earlier call to /check or /entity. Used when an operation requires two entityIds

Headers

api_keystringRequired
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.

Request

The role and optional updated entity details for the association to be created.
addedBystringOptional
Identity of the party that requested this association. For requests via the Frankie portal this will default to the portal username. Otherwise, if not given, this will be your company name.
entityobjectOptional
Describes all of the data being used to verify an entity.
percentageHeldobjectOptional
The details of the entity's ownership of the organisation. The percentage held is optional, but at least one of role and percentage held must be included. If the percentage held is null or omitted, then any existing ownership for the entity will be retained. If the percentage held is given, then the percentage held for the entity will be replaced, not merged. The currently assigned ownership percentages can be found in the business ownership query results, in the ownership details for the organisation, in the staticBeneficialOwners array.
roleslist of objectsOptional
The roles are optional in an association request, but at least one of roles and percentage held must be included. If the roles object is omitted, then any existing roles for the entity will be retained. To delete all roles for the entity use an empty roles array ([]). When updating roles, all the current roles for the entity must be included. They can be obtained from the business ownership query results, by going through the officers array in the ownership details for the organisation and extracting records with the ID of the entity and a non-blank 'addedBy' field.

Response

The request was valid and was successfully processed. The entity association has been updated.
entityobject or null
Describes all of the data being used to verify an entity.
percentageHeldobject or null
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.

roleslist of objects or null
The current entity association roles.

Errors