v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB

Individual Entities

Delete an individual entity

Delete Individual Entity with the matching entity ID.

delete/v2/individuals/{entityId}

Headers

api_keystring required

Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required

Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring

Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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.

X-Frankie-Background0 | 1

If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.

X-Frankie-Usernamestring

Example:fred.flintstone@frankieone.com

Username provided by API caller

Response

requestIdstring

The unique request identifier for the API call made.

entityIdstring

Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

Example response

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}