Financial API EndpointsBusiness

(AUS Only) Remove a previously created association between an entity (otherId) and a parent organisation (entityId).

Remove the association between the two given entities. If the association doesn't exist an error will be returned.

Path parameters

entityIdstringRequired

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

otherIdstringRequired

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

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired
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-CustomerChildIDstringOptional

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.

Response

The request was valid and was successfully processed. The entity association has been deleted.
requestIdstring

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.

statusMsgstring
Simple message describing the final status of the process. Only to be used in success case responses. Otherwise, use the ErrorObject.

Errors