Amiko Front Office API (2026.5.0)

The language is controlled via the language query parameter. If the language parameter is not provided, the engine will default to EN (english). Important: The cardId or cardholderId is NOT to be provided by the frontend (portal or app) but to be injected by the application backend as a request parameter. Your backend or integration layer (e.g. API Gateway) is to extract this information from an authenticated session. At least one of the two parameters needs to be present and only one should be present. If both are provided then the cardholderId will be used.

Returns all Guided Case Creation conversations associated with a given card or cardholder. Important: The cardId or cardholderId is NOT to be provided by the frontend (portal or app) but to be injected by the application backend as a request parameter. Your backend or integration layer (e.g. API Gateway) is to extract this information from an authenticated session. At least one of cardId or cardholderId must be present. If both are provided, cardholderId takes precedence. The optional issuerId parameter is used to scope the request to a specific issuer.

Creates a new Guided Case Creation conversation for the given cardholder and returns it with the first dialogue. Important: cardId and cardholderId are NOT to be provided by the frontend but injected by the application backend from an authenticated session. The request body must contain at least one transaction.

If the last message in a dialogue (meaning the messages with highest sequenceNr) is of a type that can be answered this endpoint is used to post the response. If the last message in a dialogue is of a different type, then there the dialogue is finished and no cardholder response is required/possible. The parameters on this endpoint are used to point to the conversation and the dialogue. The messageId for the message that is being answered is to be provided on the body.

Cancels the ongoing Guided Case Creation dialogue for the given conversation. Both conversationId and dialogueId must identify the active dialogue to be cancelled.

Removes the cardholder's most recent answer in the given dialogue and returns the updated conversation. Only applicable when the dialogue allows undoing; returns an error otherwise.

Marks the specified message and all messages with a lower sequenceNr as read.

Removes a previously submitted answer identified by messageId. Returns the updated conversation. Only applicable when the dialogue allows removing answers; returns an error otherwise.

Replaces a previously submitted answer in the dialogue with a new one and returns the updated conversation. The answer body must reference the messageId of the question being re-answered. Only applicable when the dialogue allows updating answers; returns an error otherwise.

Confirms and submits the completed Guided Case Creation dialogue, triggering case creation. This endpoint should be called once all questions in the dialogue have been answered. Returns the final conversation state.

Creates a new cardholder-initiated follow-up dialogue on an existing Guided Case Creation conversation. Important: cardId and cardholderId are NOT to be provided by the frontend but injected by the application backend from an authenticated session.

Returns the note saved for the given conversation, with the time it was saved and its author kind (an Amiko agent or the external API). Returns 404 if no note has been saved yet. Notes are per-conversation and not tied to a specific dialogue.

Saves or overwrites the note for the given conversation. The note is attributed to the external API and is copied to the case when the conversation is confirmed and the case is created. Notes are per-conversation and not tied to a specific dialogue.

Used to fetch image data for a logo ID provided in the rich transaction data message

Used to download a document using a documentId

Used to upload a document in order to receive a documentId that can be used to answer a message of type upload_document. Only documents with certain mimeTypes are supported.

The health status response consists of a single mandatory root field ("status") reflecting the state of the API.