Update Application

patch

https://api-staging.cermati.com/insurance/v1/generic/{trxId}

This endpoint is used to update the created application data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

trxId

string

required

The insurance transaction ID.

Body Params

The request that will be used to update an application.
For Accommodation Insurance products, application update can only be done if the application's status is either ACTIVATED, ISSUED, or DATA_INCOMPLETE.
For Goods Insurance products, application update can only be done if the application's status is DATA_INCOMPLETE.
For Property Insurance products, application update can only be done if the application's status is either ACTIVATED, DATA_COMPLETE, ISSUED, or DATA_INCOMPLETE.
For Transportation Insurance products, application update can only be done if the application's status is either ACTIVATED or ISSUED.
Other conditions than those terms, the application cannot be updated.

orderId

string

length ≤ 100

Order ID/Transaction ID/Loan Contract ID on partner’s side.

coverageStart

date-time

length ≤ 30

Date time indicating insurance coverage started (ISO 8601 format with timezone). Validation configured in product level.

coverageEnd

date-time

length ≤ 30

Date time indicating insurance coverage ended (ISO 8601 format with timezone). Validation configured in product level.

items

array of objects

The items that are included in this transaction.

items

shipment

object

The shipment in the transaction.

rents

array of objects

The details of the tenancies/rents in the transaction. It can be accommodation room details, property tenancy details, or other tenancy details.

rents

parties

array of objects

The details of the parties/people that are involved in this transaction.

parties

additionalParameters

object

Extra parameters applicable to the product. The expected fields depend on the product ID.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

403The error if the application with the given trxId cannot be updated at the moment

404The error if the application with the given trxId is not found

409The error if the refNo or trxId is locked by another request/process

422If the request body doesn't comply to our validation rules, the error will show the problematic fields

500The error if there is any error in our server