KYC V2 APIIndividual Documents

Delete an attachment

Delete an attachment from a given document.

Path parameters

entityIdstringRequired
Unique FrankieOne identifier for an entity
documentIdstringRequired
Unique identifier for a document
attachmentIdstringRequired

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
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.

X-Frankie-UsernamestringOptional
Username provided by API caller

Response

OK
requestIdstring or null
The unique request ID for the API call made.
entityIdstring or null

Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an 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 call.

documentIdstring or nullformat: "uuid"
As documents are added to an entity, they're assigned a unique identifier to assist with modification and reference. To modify a document, include the documentId in an update request call.
attachmentIdstring or null

Errors