Korint API (1.0.0)

Download OpenAPI specification:Download

health

AppController_index

Responses

invitation

InvitationController_invite

Request Body schema: application/json

policyId required	string Policy id
customerId required	string Customer id
branchId	string Branch id
email	string Email address
type required	string Enum: "COMPANY" "EMPLOYEE" "BROKER" "POLICY_OWNER" "REINVITE" "ANONYMOUS" Invite type

Responses

Request samples

Payload

Content type

application/json

{"policyId": "string",
"customerId": "string",
"branchId": "string",
"email": "string",
"type": "COMPANY"
}

Response samples

200
400

Content type

application/json

{"token": "string"
}

InvitationController_adminInvite

Request Body schema: application/json

policyId required	string Policy id
customerId required	string Customer id
branchId	string Branch id
email	string Email address
type required	string Enum: "COMPANY" "EMPLOYEE" "BROKER" "POLICY_OWNER" "REINVITE" "ANONYMOUS" Invite type

Responses

Request samples

Payload

Content type

application/json

{"policyId": "string",
"customerId": "string",
"branchId": "string",
"email": "string",
"type": "COMPANY"
}

Response samples

200
400

Content type

application/json

{"token": "string"
}

InvitationController_brokerInvite

Request Body schema: application/json

email required	string Email address to invite
brokerageFirmId required	string Brokerage firm id
permissions required	Array of strings Items Enum: "brokerage-firm:update" "brokerage-firm:broker:create" "brokerage-firm:broker:list" "brokerage-firm:broker:delete" "brokerage-firm:platform:config:update" "brokerage-firm:policies:list-all" Permissions
firstName required	string First name
lastName required	string Last name

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"brokerageFirmId": "string",
"permissions": ["brokerage-firm:update"
],
"firstName": "string",
"lastName": "string"
}

Response samples

200
400

Content type

application/json

{"token": "string"
}

InvitationController_grant

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

token

required

string

Token

Responses

Request samples

Payload

Content type

application/json

{"token": "string"
}

Response samples

200
400
404
409

Content type

application/json

Example

GrantOutput

{"customerId": "string",
"policyId": "string",
"branchId": "string"
}

InvitationController_createAnonymousSession

Responses

Response samples

200

Content type

application/json

{"sessionId": "string",
"token": "string"
}

documents

Validate document after an upload to a presigned URL

Request Body schema: application/json

key

required

string

Responses

Request samples

Payload

Content type

application/json

{"key": "string"
}

Response samples

200
409

Content type

application/json

{ }

Get documents by ID with a signed URL

query Parameters

ids

required

Array of strings

the document ids to retrieve

Responses

Response samples

200

Content type

application/json

{"documents": [{"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"name": "string",
"path": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signedUrl": "string"
}
]
}

Generate upload URL

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
name required	string the name of the document
test required	boolean is it a test customer

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"test": true
}

Response samples

200

Content type

application/json

{"url": "string",
"id": "string"
}

Delete documents by IDs

query Parameters

ids

required

Array of strings

the document ids to delete

Responses

Response samples

200

Content type

application/json

{ }

List document templates

query Parameters

groupName

string

The template group name to filter on

Responses

Response samples

200

Content type

application/json

{"data": [{"templateId": "string",
"name": "string",
"status": "string",
"createdAt": "string",
"updatedAt": "string",
"groupName": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

DEBUG: List documents by metadata

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
}
}

Response samples

200

Content type

application/json

{"data": [{"templateId": "string",
"name": "string",
"status": "string",
"createdAt": "string",
"updatedAt": "string",
"groupName": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

DEBUG: Create pdf

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
templateId required	string The template id to use
required	Array of objects (BaseValue) The payload to use

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"templateId": "string",
"payload": [{"type": "string",
"key": "string",
"value": { }
}
]
}

Response samples

200

Content type

application/json

{"id": "string"
}

DEBUG: Zip documents

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
documents required	Array of objects the document ids to zip
test	boolean is it a test document

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"documents": [{ }
],
"test": true
}

Response samples

200

Content type

application/json

{"type": "DOCUMENT",
"id": "string"
}

debug

DEBUG: List documents by metadata

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
}
}

Response samples

200

Content type

application/json

{"data": [{"templateId": "string",
"name": "string",
"status": "string",
"createdAt": "string",
"updatedAt": "string",
"groupName": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

DEBUG: Create pdf

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
templateId required	string The template id to use
required	Array of objects (BaseValue) The payload to use

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"templateId": "string",
"payload": [{"type": "string",
"key": "string",
"value": { }
}
]
}

Response samples

200

Content type

application/json

{"id": "string"
}

DEBUG: Zip documents

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
documents required	Array of objects the document ids to zip
test	boolean is it a test document

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"documents": [{ }
],
"test": true
}

Response samples

200

Content type

application/json

{"type": "DOCUMENT",
"id": "string"
}

DEBUG: List invoice by metadata

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options
issuedFrom	string <date-time> retrieve invoices issued after this date (inclusive)
issuedTo	string <date-time> retrieve invoices issued before this date (exclusive)

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
},
"issuedFrom": "2019-08-24T14:15:22Z",
"issuedTo": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"data": [{"templateId": "string",
"name": "string",
"status": "string",
"createdAt": "string",
"updatedAt": "string",
"groupName": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

PaymentsController_createCustomer

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
name required	string the name of the customer
test required	boolean is it a test customer

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"test": true
}

Response samples

200

Content type

application/json

{"id": "string"
}

List payment customers

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
}
}

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

PaymentsController_createPayment

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
amountInEuroCents required	number the amount to charge in cents of euro
stripeCustomerId required	string the id of the stripe customer
paymentMode required	string Enum: "DIRECT_DEBIT" "BANK_TRANSFER" the payment mode
paymentMethodId	string the id of the payment method

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"amountInEuroCents": 0,
"stripeCustomerId": "string",
"paymentMode": "DIRECT_DEBIT",
"paymentMethodId": "string"
}

Response samples

200
404

Content type

application/json

{"id": "string"
}

PaymentsController_setupIntent

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
stripeCustomerId required	string the id of the customer
allowedPaymentMethods required	Array of strings the allowed payment methods

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"stripeCustomerId": "string",
"allowedPaymentMethods": ["string"
]
}

Response samples

200
404

Content type

application/json

{"clientSecret": "string"
}

Get payment methods associated to a customer

query Parameters

id

required

string

the id of the stripe customer

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": { },
"id": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"paymentMethodType": "card",
"mandateDocumentId": "string",
"last4": "string",
"expirationMonth": 0,
"expirationYear": 0,
"billingDetails": {"name": "string",
"email": "string",
"phone": "string",
"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
}
}
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Get payments by customerId

path Parameters

customerId

required

string

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": { },
"id": "string",
"status": "CREATED",
"paymentMode": "DIRECT_DEBIT",
"paymentMethodId": "string",
"amountInEuroCents": 0,
"refundableAmount": 0,
"amountRefunded": 0,
"amountToRefund": 0,
"createdAt": "string",
"cancellationReason": "string",
"failureReason": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

PermissionsController_createUser

Request Body schema: application/json

userId

required

string

The ID of the user.

Responses

Request samples

Payload

Content type

application/json

{"userId": "string"
}

Response samples

200

Content type

application/json

{ }

PermissionsController_getUsers

query Parameters

ids

required

Array of strings

the user ids to retrieve

Responses

Response samples

200

Content type

application/json

{"users": [{"productId": "string",
"userId": "string",
"roles": ["string"
],
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

PermissionsController_createRole

Request Body schema: application/json

roleId required	string The ID of the role.
required	Array of objects (Permission) The permissions associated with the user.

Responses

Request samples

Payload

Content type

application/json

{"roleId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"roleId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

PermissionsController_getRoles

query Parameters

ids

required

Array of strings

the user ids to retrieve

Responses

Response samples

200

Content type

application/json

{"roles": [{"productId": "string",
"roleId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

PermissionsController_updateRole

path Parameters

roleId

required

string

Request Body schema: application/json

required

Array of objects (Permission)

The permissions associated with the user.

Array

permissionId required	string The ID of the permission.
resourceIds required	Array of strings The ID of the resources.

Responses

Request samples

Payload

Content type

application/json

{"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"roleId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

PermissionsController_deleteRole

path Parameters

roleId

required

string

Responses

Response samples

200

Content type

application/json

{"roleId": "string"
}

attach roles by resources on a user

path Parameters

userId

required

string

Request Body schema: application/json

roles

required

Array of strings

User role ids

Responses

Request samples

Payload

Content type

application/json

{"roles": ["string"
]
}

Response samples

200

Content type

application/json

{"userId": "string",
"roles": ["string"
]
}

detach roles by ressources on a user

path Parameters

userId

required

string

Request Body schema: application/json

roles

required

Array of strings

User role ids

Responses

Request samples

Payload

Content type

application/json

{"roles": ["string"
]
}

Response samples

200
404

Content type

application/json

{"userId": "string",
"roles": ["string"
]
}

attach permissions by resources on a user

path Parameters

userId

required

string

Request Body schema: application/json

required

Array of objects (Permission)

The permissions associated with the user.

Array

permissionId required	string The ID of the permission.
resourceIds required	Array of strings The ID of the resources.

Responses

Request samples

Payload

Content type

application/json

{"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"userId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

check permissions by resources on a user

path Parameters

userId

required

string

Request Body schema: application/json

permission required	string permission to check
resources required	Array of strings resources to check

Responses

Request samples

Payload

Content type

application/json

{"permission": "string",
"resources": ["string"
]
}

Response samples

200

Content type

application/json

{ }

detach permissions by resources on a user

path Parameters

userId

required

string

Request Body schema: application/json

required

Array of objects (Permission)

The permissions associated with the user.

Array

permissionId required	string The ID of the permission.
resourceIds required	Array of strings The ID of the resources.

Responses

Request samples

Payload

Content type

application/json

{"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

Response samples

200
404

Content type

application/json

{"userId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

attach permissions by resources on a role

path Parameters

roleId

required

string

Request Body schema: application/json

required

Array of objects (Permission)

The permissions associated with the role.

Array

permissionId required	string The ID of the permission.
resourceIds required	Array of strings The ID of the resources.

Responses

Request samples

Payload

Content type

application/json

{"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

Response samples

200

Content type

application/json

{"roleId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

detach permissions by resources on a role

path Parameters

roleId

required

string

Request Body schema: application/json

required

Array of objects (Permission)

The permissions associated with the role.

Array

permissionId required	string The ID of the permission.
resourceIds required	Array of strings The ID of the resources.

Responses

Request samples

Payload

Content type

application/json

{"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

Response samples

200
404

Content type

application/json

{"roleId": "string",
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
]
}

TEST Calculate invoices

path Parameters

policyId

required

string

Unique identifier for the policy

Responses

Response samples

200
400

Content type

application/json

{"incrementalId": 0,
"externalPolicyId": "string"
}

TEST send transactional email

Request Body schema: application/json

userId	string User ID
scopes	Array of strings User Scopes
tenantId required	string Unique identifier for the tenant
productId	string Unique identifier for the product
key required	string
required	Array of objects (Metadata) metadata assigned to the object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"scopes": ["string"
],
"tenantId": "string",
"productId": "string",
"key": "string",
"metadata": [{"key": "string",
"value": "string"
}
]
}

Response samples

400

Content type

application/json

null

ReportingController_updateInvoiceReportingTable

Request Body schema: application/json

object (UpdateInvoiceReportingTableInputBody)

Responses

Request samples

Payload

Content type

application/json

{ }

ReportingController_queryInvoicePolicyDetailsReportingTable

Request Body schema: application/json

object (QueryInvoicePolicyDetailsReportingTableInputBody)

Responses

Request samples

Payload

Content type

application/json

{ }

ReportingController_queryInvoicingSchedulePolicyDetailsReportingTable

Request Body schema: application/json

object (QueryInvoicingSchedulePolicyDetailsReportingTableInputBody)

Responses

Request samples

Payload

Content type

application/json

{ }

QuoteController_getQuote

path Parameters

productId

required

string

Request Body schema: application/json

	object Parent customer data
	object Parent policy data
required	object Customer data
required	object Policy data
required	object Branch data
required	Array of objects (AssetDto) Assets data
required	object Fleet volatility data
required	Array of objects (AssetQuoteOptionsDto)

Responses

Request samples

Payload

Content type

application/json

{"parentCustomer": {"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": { },
"id": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "CUSTOMER_CREATED",
"policies": ["string"
],
"invoices": ["string"
],
"preferredPaymentMethodId": "string",
"paymentMode": "DIRECT_DEBIT"
},
"parentPolicy": {"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
],
"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"owners": [{"userId": "string",
"email": "string",
"roles": [{"productId": "string",
"roleId": "string"
}
]
}
],
"type": "string",
"id": "string",
"parent": "string",
"brokerageFirm": "string",
"productId": "string",
"incrementalId": 0,
"externalId": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"branchType": "BASE",
"startedAt": "string",
"endedAt": "string",
"stoppedAt": "string",
"assets": ["string"
],
"customer": "string",
"invoicingConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"acceptedEmailDomains": ["string"
],
"acceptedQuoteOptions": {"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"additionalQuoteComponents": {"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"maximumNumberOfBikes": 0,
"stop": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
},
"customer": {"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": { },
"id": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "CUSTOMER_CREATED",
"policies": ["string"
],
"invoices": ["string"
],
"preferredPaymentMethodId": "string",
"paymentMode": "DIRECT_DEBIT"
},
"policy": {"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
],
"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"owners": [{"userId": "string",
"email": "string",
"roles": [{"productId": "string",
"roleId": "string"
}
]
}
],
"type": "string",
"id": "string",
"parent": "string",
"brokerageFirm": "string",
"productId": "string",
"incrementalId": 0,
"externalId": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"branchType": "BASE",
"startedAt": "string",
"endedAt": "string",
"stoppedAt": "string",
"assets": ["string"
],
"customer": "string",
"invoicingConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"acceptedEmailDomains": ["string"
],
"acceptedQuoteOptions": {"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"additionalQuoteComponents": {"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"maximumNumberOfBikes": 0,
"stop": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
},
"branch": {"name": "string",
"id": "string",
"type": "BRANCH",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"renewalStatus": "RENEWAL_ACCEPTED",
"branchType": "BASE",
"branchStatus": "BRANCH_OPEN",
"closeReason": "BROKER_REQUEST"
},
"assets": [{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": "string",
"id": "string",
"lastModifiedAt": "string",
"createdAt": "string",
"status": "ASSET_CREATED",
"createdOnBranch": true,
"editedOnBranch": true,
"startedAt": "string",
"stoppedAt": "string",
"cancelledAt": "string",
"externalAssetId": "string",
"legacyTechnicalPremium": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"legacyQuote": {"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"tiers": [{"id": "string",
"perils": [{"id": "string",
"rate": 0,
"flat": 0,
"tax": 0
}
],
"total": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
}
}
]
},
"legacyOptions": {"tier": "string",
"recommendedTier": "string"
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"options": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
}
}
],
"assetsVolatility": {"vehiclesCoverDays": 0,
"score": 0
},
"options": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
}
]
}

Response samples

200
400
404

Content type

application/json

{"policy": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"assets": [{"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"options": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
}
]
}

QuoteController_getExternalQuote

query Parameters

quoteId

required

string

Internal Korint quote id

Responses

Response samples

200
404

Content type

application/json

{ }

Admin only: Get tenant config

Responses

Response samples

200
400

Content type

application/json

{"cognitoUserPoolId": "string",
"emails": [{"trigger": "string",
"filters": ["string"
],
"templateId": "string",
"templateFields": [{"key": "string",
"value": "string"
}
],
"receiverEmail": {"entity": { },
"customFieldKey": "string",
"useCustomerContactEmail": true
},
"ownerEmail": {"usePolicyOwnerEmail": true,
"roleId": "string"
},
"brokerEmail": {"useBrokerageFirmOwnerEmail": true,
"roleId": "string"
},
"attachments": [{"type": "string",
"signed": true
}
],
"payload": {"target": "string",
"businessObjects": ["string"
]
},
"calculate": ["string"
],
"messageData": ["string"
]
}
],
"stripeAccountId": "string",
"externalInvoiceIdFormat": "string",
"products": { }
}

Admin only: Get product config

path Parameters

productId

required

string

Responses

Response samples

200
400

Content type

application/json

{"productId": "string",
"parentProductId": "string",
"childProductId": "string",
"type": "INDIVIDUAL",
"linkedServices": ["DRIVEQUANT"
],
"externalProductId": "string",
"generateExternalPolicyIdTrigger": "CREATION",
"externalPolicyIdFormat": "string",
"enableMta": true,
"allowDirectSale": true,
"allowBrokerSale": true,
"assetStartedAtLimit": {"min": { },
"max": { }
},
"engagementDuration": {"amount": 0,
"unit": { }
},
"listOfIntegrations": ["Siv"
],
"customerFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"policyFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"assetFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"grantConfigs": [{"inviteType": "COMPANY",
"tokenType": "ONE_TIME",
"tokenExpiration": "string",
"permissions": [{"permissionId": "string",
"attachToProduct": "PRODUCT",
"resourceTypes": ["CUSTOMER"
]
}
],
"roles": [{"roleId": "string",
"attachToProduct": "PRODUCT"
}
],
"usesBranch": true,
"forceSendEmail": true
}
],
"customEvents": {"customer": ["string"
],
"policy": ["string"
],
"asset": ["string"
]
},
"policyAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"customerAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"assetAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"individualPolicyConfig": {"pricing": {"type": "FIXED",
"frequency": "YEARLY"
},
"quoteInvalidation": {"allowSignatureAfterBranchStartAt": true,
"maxQuoteValidityPeriodInDays": 0
},
"quote": {"availableTiers": [{"id": "string",
"label": "string"
}
],
"availableExcesses": [{"id": "string",
"label": "string"
}
],
"availablePerils": [{"id": "string",
"label": "string",
"options": ["string"
]
}
],
"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"allowedTotalCommissionFee": {"min": 100,
"max": 100,
"default": 100
}
},
"collectivePolicyConfig": {"paymentLevelKey": { }
},
"claims": { },
"payment": {"allowedPaymentModes": ["DIRECT_DEBIT"
],
"allowedPaymentMethods": ["card"
],
"sepaMandate": {"mandateDocument": {"type": "string",
"templateId": "string",
"trigger": ["string"
],
"filters": ["string"
],
"target": "string",
"businessObjects": ["string"
]
},
"mandateSignature": {"type": "string",
"signature": "VIEW",
"anchor": {"page": { },
"x": 0,
"y": 0,
"height": 0,
"width": 0
},
"mentions": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"mention": "string"
}
],
"texts": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"maxLength": 0,
"question": "string",
"instruction": "string",
"optional": true
}
],
"checkboxes": [{"page": { },
"x": 0,
"y": 0,
"size": 0,
"name": "string",
"optional": true,
"checked": true
}
]
}
},
"paymentMethodOnEarlyPayment": ["card"
],
"paymentMethodOnRecurringPayment": ["card"
]
},
"billing": {"defaultConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"availableConfigs": [{"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
}
]
},
"taxes": ["string"
],
"nonRefundableComponents": ["string"
],
"renewal": {"renewalPeriod": {"amount": 0,
"unit": { }
},
"tacitRenewal": true,
"renewalStopReason": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
},
"renewalQuote": {"components": [{"id": "string",
"premiumRate": 0,
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
]
}
}
]
},
"crmParameters": {"crmCalculationParameters": {"usage": "TOURING_OR_ALL_PURPOSE"
},
"crmLimitParameters": {"maxCrm": 0,
"crmStopReason": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
},
"crmQuoteParameters": {"componentsNotImpacted": ["string"
]
}
}
},
"commonDocuments": [{"type": "string"
}
],
"generatedDocuments": [{"type": "string",
"templateId": "string",
"trigger": ["string"
],
"filters": ["string"
],
"target": "string",
"businessObjects": ["string"
]
}
],
"signature": {"requirePaymentMethodForNewBusiness": true,
"signedDocuments": [{"type": "string",
"signature": "VIEW",
"anchor": {"page": { },
"x": 0,
"y": 0,
"height": 0,
"width": 0
},
"mentions": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"mention": "string"
}
],
"texts": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"maxLength": 0,
"question": "string",
"instruction": "string",
"optional": true
}
],
"checkboxes": [{"page": { },
"x": 0,
"y": 0,
"size": 0,
"name": "string",
"optional": true,
"checked": true
}
]
}
]
},
"emailsConfig": {"bccEmail": "string"
},
"emails": [{"trigger": "string",
"filters": ["string"
],
"templateId": "string",
"templateFields": [{"key": "string",
"value": "string"
}
],
"receiverEmail": {"entity": { },
"customFieldKey": "string",
"useCustomerContactEmail": true
},
"ownerEmail": {"usePolicyOwnerEmail": true,
"roleId": "string"
},
"brokerEmail": {"useBrokerageFirmOwnerEmail": true,
"roleId": "string"
},
"attachments": [{"type": "string",
"signed": true
}
],
"payload": {"target": "string",
"businessObjects": ["string"
]
},
"calculate": ["string"
],
"messageData": ["string"
]
}
],
"reports": { },
"policyStopReasons": [{"reason": "string",
"details": ["string"
],
"appliedAtDate": "string",
"appliedInFutureAllowed": true,
"refundType": { },
"validForDuration": {"amount": 0,
"unit": { }
}
}
],
"tenantName": "string",
"productName": "string"
}

Admin only: Retrieves the rates of a rating table Deprecated

path Parameters

ratingTable

required

string

Responses

Response samples

200
400

Content type

application/json

{"type": "RATING_TABLE",
"id": "string",
"inputs": [{"id": "string",
"unit": "string",
"options": {"includeMin": true,
"includeMax": true
}
}
],
"factors": [{"type": "RATING_FACTORS",
"exactInputs": [{"id": "string",
"value": "string"
}
],
"rangeInputs": [{"id": "string",
"min": 0,
"max": 0
}
],
"value": 0
}
]
}

Admin only: Retrieves an Tiers config Deprecated

Responses

Response samples

200
400
404

Content type

application/json

{"total": 0,
"data": [{"type": "TIER",
"id": "string",
"name": "string",
"basePrice": 0,
"perils": [{"id": "string",
"name": "string"
}
],
"ancillaries": [{"id": "string",
"name": "string"
}
]
}
]
}

Retrieves the list of rating tables Deprecated

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"type": "RATING_TABLE",
"id": "string",
"inputs": [{"id": "string",
"unit": "string"
}
]
}
]
}

LegacyDocumentsController_getGenerationPayload

query Parameters

whenAt

required

string

Request Body schema: application/json

type required	string
targetId required	string
branchId	string
metadata	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"targetId": "string",
"branchId": "string",
"metadata": ["string"
]
}

Response samples

200
400
404

Content type

application/json

{ }

DebugController_clearTestData

Responses

DebugController_clearProjectionsData

query Parameters

rebuild	boolean
timeout	number

Responses

DebugController_clearLegacyCache

query Parameters

prefix	string Cache key prefix to clear
expired	boolean Specify to clear only expired cache entries

Responses

DebugController_getProjections

query Parameters

resourceId

required

string

Responses

DebugController_countCoreEvents

path Parameters

aggregateId

required

string

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
eventType	string

Responses

billing

Get invoices

query Parameters

simulatedAt	string Optional: the simulatedAt datetime
whenAt	string Optional: the whenAt datetime
ids required	Array of strings the invoice ids to retrieve

Responses

Response samples

200

Content type

application/json

{"data": [{"issuedAt": "string",
"lines": [{"type": "PREMIUM",
"amount": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"period": {"startedAt": "string",
"endedAt": "string"
},
"service": "PREMIUM"
}
],
"amount": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"type": "INVOICE",
"status": "DRAFTED",
"createdAt": "string",
"incrementalId": 0,
"externalId": "string",
"paymentId": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

TEST List invoice events

path Parameters

invoiceId

required

string

the invoice id

query Parameters

simulatedAt

string

Optional: the simulatedAt datetime

Responses

Response samples

404

Content type

application/json

null

DEBUG: List invoice by metadata

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options
issuedFrom	string <date-time> retrieve invoices issued after this date (inclusive)
issuedTo	string <date-time> retrieve invoices issued before this date (exclusive)

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
},
"issuedFrom": "2019-08-24T14:15:22Z",
"issuedTo": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"data": [{"templateId": "string",
"name": "string",
"status": "string",
"createdAt": "string",
"updatedAt": "string",
"groupName": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

payments

PaymentsController_createCustomer

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
name required	string the name of the customer
test required	boolean is it a test customer

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"test": true
}

Response samples

200

Content type

application/json

{"id": "string"
}

List payment customers

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
}
}

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"name": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

PaymentsController_createPayment

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
amountInEuroCents required	number the amount to charge in cents of euro
stripeCustomerId required	string the id of the stripe customer
paymentMode required	string Enum: "DIRECT_DEBIT" "BANK_TRANSFER" the payment mode
paymentMethodId	string the id of the payment method

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"amountInEuroCents": 0,
"stripeCustomerId": "string",
"paymentMode": "DIRECT_DEBIT",
"paymentMethodId": "string"
}

Response samples

200
404

Content type

application/json

{"id": "string"
}

PaymentsController_setupIntent

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
stripeCustomerId required	string the id of the customer
allowedPaymentMethods required	Array of strings the allowed payment methods

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"stripeCustomerId": "string",
"allowedPaymentMethods": ["string"
]
}

Response samples

200
404

Content type

application/json

{"clientSecret": "string"
}

Get payment methods associated to a customer

query Parameters

id

required

string

the id of the stripe customer

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": { },
"id": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"paymentMethodType": "card",
"mandateDocumentId": "string",
"last4": "string",
"expirationMonth": 0,
"expirationYear": 0,
"billingDetails": {"name": "string",
"email": "string",
"phone": "string",
"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
}
}
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Get payments by customerId

path Parameters

customerId

required

string

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": { },
"id": "string",
"status": "CREATED",
"paymentMode": "DIRECT_DEBIT",
"paymentMethodId": "string",
"amountInEuroCents": 0,
"refundableAmount": 0,
"amountRefunded": 0,
"amountToRefund": 0,
"createdAt": "string",
"cancellationReason": "string",
"failureReason": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

YousignController_webhook

Responses

Fake a signature done event

path Parameters

signature_id

required

string

Responses

List current user owned Customers and Roles

Responses

Response samples

200
404

Content type

application/json

{"userId": "string",
"roleIds": ["string"
],
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
],
"email": "string",
"isUserAdmin": true
}

PermissionsController_deleteUsers

query Parameters

ids

required

Array of strings

the user ids to delete

Responses

Response samples

200

Content type

application/json

{ }

StripeWebhookController_webhook

header Parameters

stripe-signature

required

string

Responses

StripeWebhookController_connectWebhook

header Parameters

stripe-signature

required

string

Responses

Get metrics

query Parameters

from required	string <date-time>
to required	string <date-time>
metrics required	Array of strings Items Enum: "monthly:policy:signature:done" "monthly:policy:unpaid" "monthly:policy:mta:created" "monthly:policy:mta:signed" "monthly:policy:quote:created"
resourceIds required	Array of strings
	Array of objects (Metadata) and search
	Array of objects (Metadata) or search
period required	string Enum: "MONTHLY" "ANUALLY" "DAILY" "WEEKLY" "HOURLY" "MINUTES" "SECONDS" "INSTANT"
count	number the number of items to return
page	number the page to retrieve
interpolate	boolean

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"resourceId": "string",
"metric": "string",
"value": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
],
"pageInfo": {"first": true,
"last": true
},
"currentPage": 0
}

Get latest values for each metrics

query Parameters

metrics required	Array of strings Items Enum: "monthly:policy:signature:done" "monthly:policy:unpaid" "monthly:policy:mta:created" "monthly:policy:mta:signed" "monthly:policy:quote:created"
resourceIds required	Array of strings
	Array of objects (Metadata) and search
	Array of objects (Metadata) or search

Responses

Response samples

200

Content type

application/json

{"metrics": [{"metadata": [{"key": "string",
"value": "string"
}
],
"resourceId": "string",
"metric": "string",
"value": 0,
"timestamp": "2019-08-24T14:15:22Z"
}
]
}

Retrieve user data with Drivequant unique ID

Responses

Response samples

200
404

Content type

application/json

{"userId": "string",
"roleIds": ["string"
],
"permissions": [{"permissionId": "string",
"resourceIds": ["string"
]
}
],
"email": "string",
"isUserAdmin": true
}

policy

Get Policy

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
403
404

Content type

application/json

{"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
],
"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"owners": [{"userId": "string",
"email": "string",
"roles": [{"productId": "string",
"roleId": "string"
}
]
}
],
"type": "string",
"id": "string",
"parent": "string",
"brokerageFirm": "string",
"productId": "string",
"incrementalId": 0,
"externalId": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"branchType": "BASE",
"startedAt": "string",
"endedAt": "string",
"stoppedAt": "string",
"assets": ["string"
],
"customer": "string",
"invoicingConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"acceptedEmailDomains": ["string"
],
"acceptedQuoteOptions": {"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"additionalQuoteComponents": {"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"maximumNumberOfBikes": 0,
"stop": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
}

Edit Policy

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branchId

Request Body schema: application/json

	Array of objects (CustomFieldDto) custom fields per product
name	string Optional: Name of the entity
	object the policy's invoicing configuration
acceptedEmailDomains	Array of strings the child policy's customer accepted email domains
	object (AcceptedQuoteOptionsDto)
maximumNumberOfBikes	number >= 1 max number of bike

Responses

Request samples

Payload

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"invoicingConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"acceptedEmailDomains": ["string"
],
"acceptedQuoteOptions": {"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"maximumNumberOfBikes": 1
}

Response samples

200
400
403
404
409

Content type

application/json

{ }

List Policies

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
offset	number Default: 0 the pagination offset
pageSize	number Default: 50 the pagination page size
signed	boolean retrieve only signed policies
latest	boolean Default: false flag to use latest policy data
brokerageFirmId	string list policies of a specific brokerage firm (requires the permission brokerage-firm:policies:list-all)

Responses

Response samples

200

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
],
"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"owners": [{"userId": "string",
"email": "string",
"roles": [{"productId": "string",
"roleId": "string"
}
]
}
],
"type": "string",
"id": "string",
"parent": "string",
"brokerageFirm": "string",
"productId": "string",
"incrementalId": 0,
"externalId": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"branchType": "BASE",
"startedAt": "string",
"endedAt": "string",
"stoppedAt": "string",
"assets": ["string"
],
"customer": "string",
"invoicingConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"acceptedEmailDomains": ["string"
],
"acceptedQuoteOptions": {"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"additionalQuoteComponents": {"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"maximumNumberOfBikes": 0,
"stop": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
}
]
}

List child policies

path Parameters

policyId

required

string

policyId

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
offset	number Default: 0 the pagination offset
pageSize	number Default: 50 the pagination page size
signed	boolean
latest	boolean Default: false flag to use latest policy data

Responses

Response samples

200

Content type

application/json

{"offset": 0,
"limit": 0,
"total": 0,
"data": [{"policy": {"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
],
"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"owners": [{"userId": "string",
"email": "string",
"roles": [{"productId": "string",
"roleId": "string"
}
]
}
],
"type": "string",
"id": "string",
"parent": "string",
"brokerageFirm": "string",
"productId": "string",
"incrementalId": 0,
"externalId": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"branchType": "BASE",
"startedAt": "string",
"endedAt": "string",
"stoppedAt": "string",
"assets": ["string"
],
"customer": "string",
"invoicingConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"acceptedEmailDomains": ["string"
],
"acceptedQuoteOptions": {"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": [null
]
}
]
}
]
},
"additionalQuoteComponents": {"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": null,
"brokerageFirmId": null,
"chargeType": null,
"amount": null
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": null,
"chargeType": null,
"amount": null
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"maximumNumberOfBikes": 0,
"stop": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
},
"customer": { }
}
]
}

List Assets On Policy

path Parameters

policyId

required

string

policyId

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
403
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": "string",
"id": "string",
"lastModifiedAt": "string",
"createdAt": "string",
"status": "ASSET_CREATED",
"createdOnBranch": true,
"editedOnBranch": true,
"startedAt": "string",
"stoppedAt": "string",
"cancelledAt": "string",
"externalAssetId": "string",
"legacyTechnicalPremium": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"legacyQuote": {"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"tiers": [{"id": "string",
"perils": [{"id": "string",
"rate": 0,
"flat": 0,
"tax": 0
}
],
"total": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
}
}
]
},
"legacyOptions": {"tier": "string",
"recommendedTier": "string"
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"options": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
}
}
]
}

TEST Calculate invoices

path Parameters

policyId

required

string

Unique identifier for the policy

Responses

Response samples

200
400

Content type

application/json

{"incrementalId": 0,
"externalPolicyId": "string"
}

Generate Upload Document Url

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branchId

Request Body schema: application/json

name required	string name
	Array of objects (Metadata) metadata of the policy

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"metadata": [{"key": "category",
"value": "kbis"
}
]
}

Response samples

200
400
403
404

Content type

application/json

{"url": "string",
"id": "string"
}

List policy documents.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
archived	boolean Are documents archives

Responses

Response samples

200
403
404

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"name": "string",
"path": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signedUrl": "string",
"isSigned": true
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Delete policy documents by id.

path Parameters

policyId

required

string

query Parameters

ids

required

Array of strings

the document ids to delete

Responses

Response samples

200
403
404

Content type

application/json

{ }

Declare Policy Claims History Deprecated

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

required

Array of objects (ClaimsHistory)

Claims history

Array

year required	number Year of the claim
claimsNumber required	number Number of claims
fleetSize required	number Fleet size

Responses

Request samples

Payload

Content type

application/json

{"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
]
}

Response samples

200
400
403
404
409

Content type

application/json

{ }

GetPolicyClaimsHistory Deprecated

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
403
404

Content type

application/json

{"claimsHistory": [{"year": 0,
"claimsNumber": 0,
"fleetSize": 0
}
]
}

Confirm the policy. The policy and its assets all become [CONFIRMED](#object-statuses) and can no longer be modified in the New Business flow.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Responses

Response samples

200
400
403
404
409

Content type

application/json

{ }

Generate signature request for a policy.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

deliveryMode

required

string

Enum: "EMAIL" "URL"

the delivery mode

Responses

Request samples

Payload

Content type

application/json

{"deliveryMode": "EMAIL"
}

Response samples

Content type

application/json

{"id": "string",
"signers": [{"customerId": "string",
"url": "string"
}
]
}

List branches on the policy

Returns a list of open branches on the policy at the simulated date. The branches are sorted by creation date, with the oldest branch appearing first. If no simulated date is passed, this endpoint returns all branches still open after the application of every event pertaining to them, as branches that are merged or dropped will not appear. For example, if a branch is created on 01/01/2023 and merged/dropped on 05/01/2023, the branch will appear in the result if listing branches at dates 01/01/2023-05/01/2023; before 01/01/2023, the branch will not appear as it was not created; after 05/01/2023, the branch will not appear as it was merged or dropped.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchType	string Enum: "BASE" "NEW_BUSINESS" "MTA" "RENEWAL" the branch type
branchStatus	string Enum: "BRANCH_OPEN" "BRANCH_MERGED" "BRANCH_CLOSED" the branch status

Responses

Response samples

200
403
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"name": "string",
"id": "string",
"type": "BRANCH",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "POLICY_CREATED",
"renewalStatus": "RENEWAL_ACCEPTED",
"branchType": "BASE",
"branchStatus": "BRANCH_OPEN",
"closeReason": "BROKER_REQUEST"
}
]
}

GetPremiumSchedule

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branchId
startAt required	string when to start the premium schedule
endAt	string when to end the premium schedule

Responses

Response samples

200
403
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"year": 0,
"month": 0,
"activeAssetCount": 0,
"policyPremium": {"perils": [{"id": "string",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"assets": [{"id": "string",
"premium": {"perils": [{"id": "string",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [null
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [null
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"activePercentage": 0
}
]
}
]
}

List policy, asset or customer events.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"aggregateId": "string",
"aggregateType": "PAYMENT_METHOD",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"type": "string",
"data": { },
"metadata": {"tenantId": "string",
"createdAt": "string",
"appliedAt": "string",
"originalRequestId": "string",
"isSimulated": true
}
}
]
}

Push policy custom event.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branch id

Request Body schema: application/json

	Array of objects (Metadata) metadata assigned to the object
eventType required	string The event type

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"eventType": "string"
}

Response samples

200
400
404

Content type

application/json

{ }

Quote the policy

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

Array of objects (AssetQuoteOptionsDto)

Array

tier required	string
excess required	string
	Array of objects (ConfigQuoteChosenWarrantyDto)
assetId required	string
	Array of objects (BrokerageFirmsFeesDto)

Responses

Request samples

Payload

Content type

application/json

{"options": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
}
]
}

Response samples

200
400
403
404
409

Content type

application/json

{ }

Get Aggregate

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
aggregateId required	string the aggregate id

Responses

Response samples

200
404

Content type

application/json

{ }

Calculate policy quote

Calculate quote information for a policy without actually quoting it. The quote contains the full pricing details, i.e. base prices for assets or policy, the multipliers applied, peril breakdown, etc.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Request Body schema: application/json

	Array of objects (AssetQuoteOptionsDto)
	Array of objects (CustomFieldDto) Custom fields you want to override
assetIds	Array of strings The assets ids to quote

Responses

Request samples

Payload

Content type

application/json

{"options": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
}
],
"customFieldsToOverride": [{"key": "string",
"value": "string"
}
],
"assetIds": ["string"
]
}

Response samples

200
400
404
409

Content type

application/json

{"policy": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
},
"assets": [{"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"options": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
}
]
}

Get policy premium projection

Returns the calendar and policy premium projection of the policy calculated at the individual signature date

path Parameters

policyId

required

string

the policy id

Responses

Response samples

200
400
404

Content type

application/json

{"premiumProjection": [{"year": 0,
"month": 0,
"activeAssetCount": 0,
"policyPremium": {"perils": [{"id": "string",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"assets": [{"id": "string",
"premium": {"perils": [{"id": "string",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [null
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [null
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
},
"activePercentage": 0
}
]
}
]
}

Stop the policy. The policy and its assets all become [STOPPED](#object-statuses) and can no longer be modified.

path Parameters

policyId

required

string

the policy id

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

reason required	string
	Array of objects (CustomFieldDto)

Responses

Request samples

Payload

Content type

application/json

{"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}

Response samples

200
400
403
404
409

Content type

application/json

{ }

Register additional quote components for a policy

path Parameters

policyId

required

string

the policy's id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branchId

Request Body schema: application/json

required

Array of objects (QuoteComponentDto)

additional quote components

Array

id required	string Component identifier
type required	string Enum: "PREMIUM" "PERIL" "FEE" "TAX" "SPECIAL" Component type
chargeType required	string Enum: "ONE_TIME" "SPOT" "RECURRING" Charge type of component
required	object Premium information of component

Responses

Request samples

Payload

Content type

application/json

{"additionalQuoteComponents": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
}

Response samples

200

Content type

application/json

{ }

branch

Create a branch

path Parameters

policyId

required

string

Unique identifier for the policy

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

name	string Optional: Name of the entity
branchType required	string Enum: "BASE" "NEW_BUSINESS" "MTA" "RENEWAL" Branch type

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"branchType": "BASE"
}

Response samples

200
400
404
409

Content type

application/json

{"type": { },
"id": "string"
}

Fork a branch until its XXX_QUOTED events

path Parameters

policyId required	string Unique identifier for the policy
branchId required	string Unique identifier for the branch

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

name	string Optional: Name of the entity
closeOriginalBranch	boolean
branchType	string Enum: "BASE" "NEW_BUSINESS" "MTA" "RENEWAL" Branch type

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"closeOriginalBranch": true,
"branchType": "BASE"
}

Response samples

200
400
404
409

Content type

application/json

{"type": { },
"id": "string"
}

Close a branch

path Parameters

policyId required	string Unique identifier for the policy
branchId required	string Unique identifier for the branch

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

reason

required

string

Enum: "BROKER_REQUEST" "CUSTOMER_REQUEST" "FORKED" "ASSET_START_PASSED" "CONCURRENT_BRANCH_MERGED" "QUOTE_INVALIDATED" "PARTITION_DROPPED" "RENEWAL_REFUSED" "CRM_ABOVE_LIMIT"

Responses

Request samples

Payload

Content type

application/json

{"reason": "BROKER_REQUEST"
}

Response samples

200
404
409

Content type

application/json

{ }

Finalize the renewal proposition : accept or refuse it

path Parameters

policyId required	string Unique identifier for the policy
branchId required	string Unique identifier for the branch

query Parameters

whenAt	string Optional: the whenAt datetime
finalizationType required	string Enum: "ACCEPTED" "REFUSED" Finalization type

Responses

Response samples

200
404
409

Content type

application/json

{ }

customer

Get Customer

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
404

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": { },
"id": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "CUSTOMER_CREATED",
"policies": ["string"
],
"invoices": ["string"
],
"preferredPaymentMethodId": "string",
"paymentMode": "DIRECT_DEBIT"
}

Edit Customer

path Parameters

customerId

required

string

the customer's id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branchId

Request Body schema: application/json

	Array of objects (CustomFieldDto) custom fields per product
name	string Optional: Name of the entity
siret	string Optional: Siret number

Responses

Request samples

Payload

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"siret": "string"
}

Response samples

200
400
404
409

Content type

application/json

{ }

Get Customer Payment Methods

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": { },
"id": "string",
"status": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"paymentMethodType": "card",
"mandateDocumentId": "string",
"last4": "string",
"expirationMonth": 0,
"expirationYear": 0,
"billingDetails": {"name": "string",
"email": "string",
"phone": "string",
"address": {"city": "string",
"country": "string",
"line1": "string",
"line2": "string",
"postalCode": "string",
"state": "string"
}
},
"isPreferred": true
}
]
}

Get Customer Payments

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": { },
"id": "string",
"status": "CREATED",
"paymentMode": "DIRECT_DEBIT",
"paymentMethodId": "string",
"amountInEuroCents": 0,
"refundableAmount": 0,
"amountRefunded": 0,
"amountToRefund": 0,
"createdAt": "string",
"cancellationReason": "string",
"failureReason": "string"
}
]
}

Get Payment Method Setup Secret

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
400
404

Content type

application/json

{"clientSecret": "string"
}

List Customers

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
offset	number Default: 0 the pagination offset
pageSize	number Default: 50 the pagination page size
latest	boolean Default: false flag to use latest data
signed	boolean retrieve only customers that have a signed policy

Responses

Response samples

200

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": { },
"id": "string",
"createdAt": "string",
"lastModifiedAt": "string",
"status": "CUSTOMER_CREATED",
"policies": ["string"
],
"invoices": ["string"
],
"preferredPaymentMethodId": "string",
"paymentMode": "DIRECT_DEBIT"
}
]
}

Initialize customer

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

parentPolicyId

string

Policy id of the parent collective policy if current policy is a child of it

Responses

Request samples

Payload

Content type

application/json

{"parentPolicyId": "string"
}

Response samples

200
400
404
409

Content type

application/json

{"type": { },
"id": "string",
"initializedWith": {"policy": "string",
"branch": "string"
},
"accessToken": "string"
}

Push customer custom event.

path Parameters

customerId

required

string

the customer id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branch id

Request Body schema: application/json

	Array of objects (Metadata) metadata assigned to the object
eventType required	string The event type

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"eventType": "string"
}

Response samples

200
400
404

Content type

application/json

{ }

List Invoice On Customer

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"issuedAt": "string",
"lines": [{"type": "PREMIUM",
"amount": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"period": {"startedAt": "string",
"endedAt": "string"
},
"service": "PREMIUM"
}
],
"amount": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"type": "INVOICE",
"status": "DRAFTED",
"createdAt": "string",
"incrementalId": 0,
"externalId": "string",
"paymentId": "string",
"signedUrl": "string"
}
]
}

Get invoicing schedule

path Parameters

customerId

required

string

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
400
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"issuedAt": "string",
"lines": [{"type": "PREMIUM",
"amount": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"period": {"startedAt": "string",
"endedAt": "string"
},
"service": "PREMIUM"
}
],
"amount": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
}
}
]
}

Generate mandate signature request

path Parameters

customerId required	string the customer id
paymentMethodId required	string

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

deliveryMode

required

string

Enum: "EMAIL" "URL"

the delivery mode

Responses

Request samples

Payload

Content type

application/json

{"deliveryMode": "EMAIL"
}

Response samples

200
400
404
409
425

Content type

application/json

{"id": "string",
"signers": [{"customerId": "string",
"url": "string"
}
]
}

Update customer preferred payment method

path Parameters

customerId required	string the customer id
paymentMethodId required	string

query Parameters

whenAt

string

Optional: the whenAt datetime

Responses

Response samples

200
400
404
409

Content type

application/json

{ }

Update customer payment mode

path Parameters

customerId

required

string

the customer id

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

paymentMode

required

string

Enum: "DIRECT_DEBIT" "BANK_TRANSFER"

the customer payment mode

Responses

Request samples

Payload

Content type

application/json

{"paymentMode": "DIRECT_DEBIT"
}

Response samples

200
400
404
409

Content type

application/json

{ }

Get bank transfer account

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
400
404
409

Content type

application/json

{"iban": "string",
"bic": "string",
"countryCode": "string",
"accountHolderName": "string"
}

Attempt a charge for an invoice

path Parameters

customerId

required

string

The customer id

query Parameters

whenAt

string

Optional: the whenAt datetime

Request Body schema: application/json

invoiceId required	string the invoice id to retry a charge on
paymentMethodId	string Payment method to use. If not provided, the default payment method will be used.

Responses

Request samples

Payload

Content type

application/json

{"invoiceId": "string",
"paymentMethodId": "string"
}

Response samples

200
400
404

Content type

application/json

{"iban": "string",
"bic": "string",
"countryCode": "string",
"accountHolderName": "string"
}

asset

Create Asset

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

	Array of objects (CustomFieldDto) custom fields per product
name	string Optional: Name of the entity
policyId required	string policyId of asset owner
externalAssetId	string externalAssetId
startedAt	string startedAt

Responses

Request samples

Payload

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"policyId": "string",
"externalAssetId": "string",
"startedAt": "string"
}

Response samples

200
400
403
404
409

Content type

application/json

{"type": "string",
"id": "string"
}

AssetController_replaceAsset

path Parameters

originAssetId

required

string

originAssetId

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

	Array of objects (CustomFieldDto) custom fields per product
name	string Optional: Name of the entity
policyId required	string policyId of asset owner
externalAssetId	string externalAssetId
replacedAt	string original asset stoppedAt

Responses

Request samples

Payload

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"policyId": "string",
"externalAssetId": "string",
"replacedAt": "string"
}

AssetController_editAsset

path Parameters

assetId

required

string

assetId

query Parameters

whenAt	string Optional: the whenAt datetime
branchId	string Optional: the branchId

Request Body schema: application/json

	Array of objects (CustomFieldDto) custom fields per product
name	string Optional: Name of the entity
externalAssetId	string externalAssetId
startedAt	string startedAt
stoppedAt	string stoppedAt

Responses

Request samples

Payload

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"externalAssetId": "string",
"startedAt": "string",
"stoppedAt": "string"
}

Response samples

200
400
403
404
409

Content type

application/json

{ }

Get Asset

path Parameters

assetId

required

string

assetId

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId

Responses

Response samples

200
403
404

Content type

application/json

{"customFields": [{"key": "string",
"value": "string"
}
],
"name": "string",
"type": "string",
"id": "string",
"lastModifiedAt": "string",
"createdAt": "string",
"status": "ASSET_CREATED",
"createdOnBranch": true,
"editedOnBranch": true,
"startedAt": "string",
"stoppedAt": "string",
"cancelledAt": "string",
"externalAssetId": "string",
"legacyTechnicalPremium": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
},
"legacyQuote": {"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"tiers": [{"id": "string",
"perils": [{"id": "string",
"rate": 0,
"flat": 0,
"tax": 0
}
],
"total": {"preTaxes": 0,
"taxes": 0,
"taxesIncluded": 0
}
}
]
},
"legacyOptions": {"tier": "string",
"recommendedTier": "string"
},
"quote": {"id": "string",
"entityId": "string",
"provider": {"id": "string",
"version": "string"
},
"basePrice": 0,
"rates": [{"id": "string",
"rate": 0,
"inputs": [{"id": "string",
"value": "string"
}
]
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
},
"options": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
],
"assetId": "string",
"brokerageFirmFees": [{"brokerageFirmId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
},
"components": [{"id": "string",
"type": "PREMIUM",
"chargeType": "ONE_TIME",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}
]
}
}

Removes the asset from its policy. This operation is only possible if the asset has been created on the same branch it is being removed on

path Parameters

assetId

required

string

assetId

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Responses

Response samples

200
400
403
404
409

Content type

application/json

{ }

Select tier options for an asset Deprecated

path Parameters

assetId

required

string

assetId

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

tier

required

string

tier

Responses

Request samples

Payload

Content type

application/json

{"tier": "string"
}

Response samples

200
400
404
409

Content type

application/json

{ }

Push asset custom event.

path Parameters

assetId

required

string

the asset id

query Parameters

whenAt	string Optional: the whenAt datetime
branchId required	string the branchId

Request Body schema: application/json

	Array of objects (Metadata) metadata assigned to the object
eventType required	string The event type

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"eventType": "string"
}

Response samples

200
400
404

Content type

application/json

{ }

notification

TEST send transactional email

Request Body schema: application/json

userId	string User ID
scopes	Array of strings User Scopes
tenantId required	string Unique identifier for the tenant
productId	string Unique identifier for the product
key required	string
required	Array of objects (Metadata) metadata assigned to the object

Responses

Request samples

Payload

Content type

application/json

{"userId": "string",
"scopes": ["string"
],
"tenantId": "string",
"productId": "string",
"key": "string",
"metadata": [{"key": "string",
"value": "string"
}
]
}

Response samples

400

Content type

application/json

null

reporting

Generate a report

Request Body schema: application/json

type required	string Enum: "INVOICES" "WORKFLOWS" "WAKAM_ASSETS" "WAKAM_ASSISTANCE" "WAKAM_POLICIES" "WAKAM_CASH_STATEMENT" "WAKAM_RECEIPTS" "HR_MONTHLY" "YEET_VTC_IMA_ASSISTANCE" "YEET_VTC_STAKEHOLDERS" "YEET_VTC_RECEIPTS" "YEET_VTC_POLICIES" "YEET_VTC_CASH_STATEMENT" The type of report
required	Array of objects (Metadata) Report specific parameters
uploadToConnectors	boolean uploadToConnectors

Responses

Request samples

Payload

Content type

application/json

{"type": "INVOICES",
"params": [{"key": "string",
"value": "string"
}
],
"uploadToConnectors": true
}

Response samples

200
400

Content type

application/json

{ }

Get report data

Request Body schema: application/json

type required	string Enum: "INVOICES" "WORKFLOWS" "WAKAM_ASSETS" "WAKAM_ASSISTANCE" "WAKAM_POLICIES" "WAKAM_CASH_STATEMENT" "WAKAM_RECEIPTS" "HR_MONTHLY" "YEET_VTC_IMA_ASSISTANCE" "YEET_VTC_STAKEHOLDERS" "YEET_VTC_RECEIPTS" "YEET_VTC_POLICIES" "YEET_VTC_CASH_STATEMENT" The type of report
required	Array of objects (Metadata) Report specific parameters
uploadToConnectors	boolean uploadToConnectors

Responses

Request samples

Payload

Content type

application/json

{"type": "INVOICES",
"params": [{"key": "string",
"value": "string"
}
],
"uploadToConnectors": true
}

Response samples

200

Content type

application/json

{"data": ["string"
]
}

Get reports

Request Body schema: application/json

required

object

the query to search for

	Array of objects (Metadata) and search
	Array of objects (Metadata) or search

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
}
}

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"name": "string",
"path": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signedUrl": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Get hr reports

path Parameters

policyId

required

string

The policy id to get the report for

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"id": "string",
"name": "string",
"path": "string",
"createdAt": "2019-08-24T14:15:22Z",
"signedUrl": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

ReportingController_updateInvoiceReportingTable

Request Body schema: application/json

object (UpdateInvoiceReportingTableInputBody)

Responses

Request samples

Payload

Content type

application/json

{ }

ReportingController_queryInvoicePolicyDetailsReportingTable

Request Body schema: application/json

object (QueryInvoicePolicyDetailsReportingTableInputBody)

Responses

Request samples

Payload

Content type

application/json

{ }

ReportingController_queryInvoicingSchedulePolicyDetailsReportingTable

Request Body schema: application/json

object (QueryInvoicingSchedulePolicyDetailsReportingTableInputBody)

Responses

Request samples

Payload

Content type

application/json

{ }

Generate All HR reports

Request Body schema: application/json

required

Array of objects (Metadata)

Report specific parameters

Array

key required	string the key of the metadata
value required	string the value of the metadata

Responses

Request samples

Payload

Content type

application/json

{"params": [{"key": "string",
"value": "string"
}
]
}

Response samples

200
400

Content type

application/json

{ }

siren

Search SIREN

Fetch company data from a SIREN API, from a SIRET, SIREN or a name

query Parameters

siren	string Optional: Siren number
siret	string Optional: Siret number
name	string Optional: Company name

Responses

Response samples

200
400

Content type

application/json

{"total": 0,
"data": [{"siren": "string",
"siret": "string",
"nafCode": "string",
"nafLabel": "string",
"name": "string",
"creationDate": "string",
"location": {"address": "string",
"postCode": "string",
"city": "string",
"country": "string"
},
"legalStatus": {"1": "string",
"2": "string",
"3": "string"
}
}
]
}

siv

Fetch vehicle data from a registration number.

query Parameters

registrationNumber

required

string(^[A-z]{2}[ -]?[0-9]{3}[ -]?[A-z]{2}$)|(^[0-9...

Responses

Response samples

200
404

Content type

application/json

{"registrationNumber": "string",
"firstRegistrationDate": "string",
"vinNumber": "string",
"mineType": "string",
"brand": "string",
"model": "string",
"vehicleType": "string",
"bodywork": "string",
"gearbox": "string",
"energy": "string",
"fiscalPower": 0,
"horsePower": 0,
"co2": 0,
"numberOfSeats": 0,
"numberOfDoors": 0,
"unladenWeight": 0,
"engineSize": 0,
"isCollector": true
}

quote

QuoteController_getAikanQuote

query Parameters

calculatedAt

string <date>

Date de calcul

Request Body schema: application/json

birthDate required	string <date> Date de naissance
drivingLicenceDate required	string <date> Date de permis
inseeCode required	string Code Insee
cspCategory required	string Enum: "FARMER" "ARTISAN" "MERCHANT" "STUDENT" "ECCLESIASTICAL_OR_CIVIL_SERVANT" "UNEMPLOYED" "RETIREE" "SEDENTARY_EMPLOYEE" "NON_SEDENTARY_EMPLOYEE" "SALESPERSON" "PROFESSION_OR_COMPANY_HEAD" CSP
monthsOfInterruptionInLast36Months required	integer Nb de mois d'interruption sur 36 mois
currentlyInsured required	boolean Êtes-vous assuré actuellement ?
numberOfResponsibleCorporalClaimsOnPeriod required	integer Nb de corporel resp. sur la période
numberOfResponsibleMaterialClaimsOnPeriod required	integer Nb de matériel resp. sur la période
numberOfNonResponsibleCorporalAndMaterialClaimsOnPeriod required	integer Nb de sinistres (Mat & Corp) non resp. sur la periode
numberOfTheftOrFireClaimsOnPeriod required	integer Nb de sinistres Vol/Incendie sur la période
numberOfGlassBreakageClaimsOnPeriod required	integer Nb de BDG et autres non resp. sur la période
resiliationForFalseDeclarationInLast36Months required	boolean Au cours des 36 derniers mois: Résiliation pour Fausse déclaration
resiliationForContractNullityInLast36Months required	boolean Au cours des 36 derniers mois: Résiliation pour Nullité du contrat
resiliationForNonPaymentInLast36Months required	boolean Au cours des 36 derniers mois: Résiliation pour Non Paiement
hitAndRunWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Délit de fuite
refusingToObeyOrSubmitToAnAlcoholOrDrugTestWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Refus d’obtempérer / de se soumettre à un contrôle d’alcoolémie/stupéfiant
lackOfInsuranceWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Défaut d'assurance
drivingWithoutLicenceWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Conduite sans Permis
drivingUnderInfluenceOfDrugsWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Conduite sous l'emprise de stupéfiant
alcoholWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Alcoolémie
alcoholRelatedOffencesWithCriminalConvictionInLast60Months required	string Enum: "ZERO" "ONE" "TWO_OR_MORE" Au cours des 60 derniers mois (condamnation pénale) : Nombre d'infractions lié à l'alcoolémie
offenceRecordedFollowingAClaimWithCriminalConvictionInLast60Months required	boolean Au cours des 60 derniers mois (condamnation pénale) : Infraction constatée suite à sinistre
gramPerLitreOfBloodRecordedWithCriminalConvictionInLast60Months	number Au cours des 60 derniers mois (condamnation pénale) : Taux constaté lors du contrôle (g/l de sang)
suspensionsInLast60Months required	string Enum: "ZERO" "ONE" "TWO_OR_MORE" Au cours des 60 derniers mois (Annulation / Suspension) : Nombre de suspension / annulation
typeOfSuspensionsInLast60Months	string Enum: "LICENCE_SUSPENSION_LESS_THAN_6_MONTHS" "LICENCE_SUSPENSION_MORE_THAN_6_MONTHS" "LICENCE_CANCELATION" Au cours des 60 derniers mois (Annulation / Suspension) : Type
commissionRate required	number [ 0 .. 100 ] Taux de commission (de 0 à 100)
dateOfFirstRegistration required	string <date> Date de 1ère mise en circulation
dateOfAcquisition required	string <date> Date d’acquisition
group required	integer [ 20 .. 36 ] Groupe SRA
class required	string Enum: "A" "B" "C" "D" "E" "F" "G" "H" "I" "J" "K" "L" "M" "N" "O" "P" Classe SRA
gearbox required	string Enum: "MANUAL" "AUTOMATIC_OR_OTHERS" Boîte de vitesse
powerSupply required	string Enum: "GASOLINE" "DIESEL" "HYBRID" "ELECTRIC" "OTHERS" Alimentation
bodywork required	string Enum: "SEDAN" "BREAK" "VAN" "MONOSPACE" "CABRIOLET" "COUPE" "VTC_OR_4X4" "OTHERS" Carrosserie
leasing required	string Enum: "LEASED" "OWNED" Location
use required	string Enum: "BUSINESS" "PRIVATE_WITH_WORK_COMMUTE" "PRIVATE" Usage
insuranceHistoryInMonths required	integer Antécédents d'assurance (en mois)
crm required	number CRM
garage required	boolean Présence d'un garage
legalProtection required	boolean Protection juridique
assistance required	string Enum: "NONE" "WITHOUT_REPLACEMENT_VEHICLE" "WITH_REPLACEMENT_VEHICLE" Assistance
glassBreakageDeductible required	integer Franchise bris de glace
otherDeductible required	string Enum: "STANDARD" "DOUBLE" Franchise autres
driverProtection required	string Enum: "150000_10PERCENT" "300000_10PERCENT" Protection conducteur
personalBelongingsCapital required	string Enum: "NONE" "1000" Capital "Effets personnels"
smallMileageOption required	string Enum: "NONE" "4000_KM" "8000_KM" "12000_KM" Option petits rouleurs
formula required	string Enum: "1" "2" "3" "4" Formule

Responses

Request samples

Payload

Content type

application/json

{"birthDate": "2019-08-24",
"drivingLicenceDate": "2019-08-24",
"inseeCode": "string",
"cspCategory": "FARMER",
"monthsOfInterruptionInLast36Months": 0,
"currentlyInsured": true,
"numberOfResponsibleCorporalClaimsOnPeriod": 0,
"numberOfResponsibleMaterialClaimsOnPeriod": 0,
"numberOfNonResponsibleCorporalAndMaterialClaimsOnPeriod": 0,
"numberOfTheftOrFireClaimsOnPeriod": 0,
"numberOfGlassBreakageClaimsOnPeriod": 0,
"resiliationForFalseDeclarationInLast36Months": true,
"resiliationForContractNullityInLast36Months": true,
"resiliationForNonPaymentInLast36Months": true,
"hitAndRunWithCriminalConvictionInLast60Months": true,
"refusingToObeyOrSubmitToAnAlcoholOrDrugTestWithCriminalConvictionInLast60Months": true,
"lackOfInsuranceWithCriminalConvictionInLast60Months": true,
"drivingWithoutLicenceWithCriminalConvictionInLast60Months": true,
"drivingUnderInfluenceOfDrugsWithCriminalConvictionInLast60Months": true,
"alcoholWithCriminalConvictionInLast60Months": true,
"alcoholRelatedOffencesWithCriminalConvictionInLast60Months": "ZERO",
"offenceRecordedFollowingAClaimWithCriminalConvictionInLast60Months": true,
"gramPerLitreOfBloodRecordedWithCriminalConvictionInLast60Months": 0,
"suspensionsInLast60Months": "ZERO",
"typeOfSuspensionsInLast60Months": "LICENCE_SUSPENSION_LESS_THAN_6_MONTHS",
"commissionRate": 100,
"dateOfFirstRegistration": "2019-08-24",
"dateOfAcquisition": "2019-08-24",
"group": 20,
"class": "A",
"gearbox": "MANUAL",
"powerSupply": "GASOLINE",
"bodywork": "SEDAN",
"leasing": "LEASED",
"use": "BUSINESS",
"insuranceHistoryInMonths": 0,
"crm": 0,
"garage": true,
"legalProtection": true,
"assistance": "NONE",
"glassBreakageDeductible": 0,
"otherDeductible": "STANDARD",
"driverProtection": "150000_10PERCENT",
"personalBelongingsCapital": "NONE",
"smallMileageOption": "NONE",
"formula": "1"
}

Response samples

200
400

Content type

application/json

{"formula": "1",
"perils": [{"id": "string",
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0,
"deductibleAmount": 0
}
}
],
"totalPremium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalFees": 0,
"amountWithFeesPreTaxes": 0,
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"totalTaxes": 0,
"amountWithFeesAndTaxes": 0
}
}

config

Admin only: Get tenant config

Responses

Response samples

200
400

Content type

application/json

{"cognitoUserPoolId": "string",
"emails": [{"trigger": "string",
"filters": ["string"
],
"templateId": "string",
"templateFields": [{"key": "string",
"value": "string"
}
],
"receiverEmail": {"entity": { },
"customFieldKey": "string",
"useCustomerContactEmail": true
},
"ownerEmail": {"usePolicyOwnerEmail": true,
"roleId": "string"
},
"brokerEmail": {"useBrokerageFirmOwnerEmail": true,
"roleId": "string"
},
"attachments": [{"type": "string",
"signed": true
}
],
"payload": {"target": "string",
"businessObjects": ["string"
]
},
"calculate": ["string"
],
"messageData": ["string"
]
}
],
"stripeAccountId": "string",
"externalInvoiceIdFormat": "string",
"products": { }
}

Admin only: Get product config

path Parameters

productId

required

string

Responses

Response samples

200
400

Content type

application/json

{"productId": "string",
"parentProductId": "string",
"childProductId": "string",
"type": "INDIVIDUAL",
"linkedServices": ["DRIVEQUANT"
],
"externalProductId": "string",
"generateExternalPolicyIdTrigger": "CREATION",
"externalPolicyIdFormat": "string",
"enableMta": true,
"allowDirectSale": true,
"allowBrokerSale": true,
"assetStartedAtLimit": {"min": { },
"max": { }
},
"engagementDuration": {"amount": 0,
"unit": { }
},
"listOfIntegrations": ["Siv"
],
"customerFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"policyFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"assetFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"grantConfigs": [{"inviteType": "COMPANY",
"tokenType": "ONE_TIME",
"tokenExpiration": "string",
"permissions": [{"permissionId": "string",
"attachToProduct": "PRODUCT",
"resourceTypes": ["CUSTOMER"
]
}
],
"roles": [{"roleId": "string",
"attachToProduct": "PRODUCT"
}
],
"usesBranch": true,
"forceSendEmail": true
}
],
"customEvents": {"customer": ["string"
],
"policy": ["string"
],
"asset": ["string"
]
},
"policyAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"customerAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"assetAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"individualPolicyConfig": {"pricing": {"type": "FIXED",
"frequency": "YEARLY"
},
"quoteInvalidation": {"allowSignatureAfterBranchStartAt": true,
"maxQuoteValidityPeriodInDays": 0
},
"quote": {"availableTiers": [{"id": "string",
"label": "string"
}
],
"availableExcesses": [{"id": "string",
"label": "string"
}
],
"availablePerils": [{"id": "string",
"label": "string",
"options": ["string"
]
}
],
"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"allowedTotalCommissionFee": {"min": 100,
"max": 100,
"default": 100
}
},
"collectivePolicyConfig": {"paymentLevelKey": { }
},
"claims": { },
"payment": {"allowedPaymentModes": ["DIRECT_DEBIT"
],
"allowedPaymentMethods": ["card"
],
"sepaMandate": {"mandateDocument": {"type": "string",
"templateId": "string",
"trigger": ["string"
],
"filters": ["string"
],
"target": "string",
"businessObjects": ["string"
]
},
"mandateSignature": {"type": "string",
"signature": "VIEW",
"anchor": {"page": { },
"x": 0,
"y": 0,
"height": 0,
"width": 0
},
"mentions": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"mention": "string"
}
],
"texts": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"maxLength": 0,
"question": "string",
"instruction": "string",
"optional": true
}
],
"checkboxes": [{"page": { },
"x": 0,
"y": 0,
"size": 0,
"name": "string",
"optional": true,
"checked": true
}
]
}
},
"paymentMethodOnEarlyPayment": ["card"
],
"paymentMethodOnRecurringPayment": ["card"
]
},
"billing": {"defaultConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"availableConfigs": [{"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
}
]
},
"taxes": ["string"
],
"nonRefundableComponents": ["string"
],
"renewal": {"renewalPeriod": {"amount": 0,
"unit": { }
},
"tacitRenewal": true,
"renewalStopReason": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
},
"renewalQuote": {"components": [{"id": "string",
"premiumRate": 0,
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
]
}
}
]
},
"crmParameters": {"crmCalculationParameters": {"usage": "TOURING_OR_ALL_PURPOSE"
},
"crmLimitParameters": {"maxCrm": 0,
"crmStopReason": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
},
"crmQuoteParameters": {"componentsNotImpacted": ["string"
]
}
}
},
"commonDocuments": [{"type": "string"
}
],
"generatedDocuments": [{"type": "string",
"templateId": "string",
"trigger": ["string"
],
"filters": ["string"
],
"target": "string",
"businessObjects": ["string"
]
}
],
"signature": {"requirePaymentMethodForNewBusiness": true,
"signedDocuments": [{"type": "string",
"signature": "VIEW",
"anchor": {"page": { },
"x": 0,
"y": 0,
"height": 0,
"width": 0
},
"mentions": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"mention": "string"
}
],
"texts": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"maxLength": 0,
"question": "string",
"instruction": "string",
"optional": true
}
],
"checkboxes": [{"page": { },
"x": 0,
"y": 0,
"size": 0,
"name": "string",
"optional": true,
"checked": true
}
]
}
]
},
"emailsConfig": {"bccEmail": "string"
},
"emails": [{"trigger": "string",
"filters": ["string"
],
"templateId": "string",
"templateFields": [{"key": "string",
"value": "string"
}
],
"receiverEmail": {"entity": { },
"customFieldKey": "string",
"useCustomerContactEmail": true
},
"ownerEmail": {"usePolicyOwnerEmail": true,
"roleId": "string"
},
"brokerEmail": {"useBrokerageFirmOwnerEmail": true,
"roleId": "string"
},
"attachments": [{"type": "string",
"signed": true
}
],
"payload": {"target": "string",
"businessObjects": ["string"
]
},
"calculate": ["string"
],
"messageData": ["string"
]
}
],
"reports": { },
"policyStopReasons": [{"reason": "string",
"details": ["string"
],
"appliedAtDate": "string",
"appliedInFutureAllowed": true,
"refundType": { },
"validForDuration": {"amount": 0,
"unit": { }
}
}
],
"tenantName": "string",
"productName": "string"
}

Get public product config

path Parameters

productId

required

string

Responses

Response samples

200
400

Content type

application/json

{"productId": "string",
"type": "INDIVIDUAL",
"linkedServices": ["DRIVEQUANT"
],
"externalProductId": "string",
"generateExternalPolicyIdTrigger": "CREATION",
"externalPolicyIdFormat": "string",
"enableMta": true,
"allowDirectSale": true,
"allowBrokerSale": true,
"assetStartedAtLimit": {"min": { },
"max": { }
},
"engagementDuration": {"amount": 0,
"unit": { }
},
"listOfIntegrations": ["Siv"
],
"customerFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"policyFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"assetFields": [{"key": "string",
"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
]
}
],
"customEvents": {"customer": ["string"
],
"policy": ["string"
],
"asset": ["string"
]
},
"policyAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"customerAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"assetAggregateFields": [{"role": "string",
"requiredFor": "CREATION",
"requiresOnChange": "CREATION",
"mtaModification": "ALLOWED",
"validationRules": [{"option": "string",
"value": { }
}
],
"isCalculated": true,
"integrationKey": { },
"defaultValue": { },
"reducer": { },
"updatesOn": ["string"
],
"key": "string"
}
],
"individualPolicyConfig": {"pricing": {"type": "FIXED",
"frequency": "YEARLY"
},
"quoteInvalidation": {"allowSignatureAfterBranchStartAt": true,
"maxQuoteValidityPeriodInDays": 0
},
"quote": {"availableTiers": [{"id": "string",
"label": "string"
}
],
"availableExcesses": [{"id": "string",
"label": "string"
}
],
"availablePerils": [{"id": "string",
"label": "string",
"options": ["string"
]
}
],
"defaultConfig": {"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"option": "string"
}
]
},
"availableConfigs": [{"tier": "string",
"excess": "string",
"perils": [{"id": "string",
"required": true,
"options": ["string"
]
}
]
}
]
},
"allowedTotalCommissionFee": {"min": 100,
"max": 100,
"default": 100
}
},
"collectivePolicyConfig": {"paymentLevelKey": { }
},
"claims": { },
"payment": {"allowedPaymentModes": ["DIRECT_DEBIT"
],
"allowedPaymentMethods": ["card"
],
"sepaMandate": {"mandateDocument": {"type": "string",
"templateId": "string",
"trigger": ["string"
],
"filters": ["string"
],
"target": "string",
"businessObjects": ["string"
]
},
"mandateSignature": {"type": "string",
"signature": "VIEW",
"anchor": {"page": { },
"x": 0,
"y": 0,
"height": 0,
"width": 0
},
"mentions": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"mention": "string"
}
],
"texts": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"maxLength": 0,
"question": "string",
"instruction": "string",
"optional": true
}
],
"checkboxes": [{"page": { },
"x": 0,
"y": 0,
"size": 0,
"name": "string",
"optional": true,
"checked": true
}
]
}
},
"paymentMethodOnEarlyPayment": ["card"
],
"paymentMethodOnRecurringPayment": ["card"
]
},
"billing": {"defaultConfig": {"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
},
"availableConfigs": [{"frequency": "YEARLY",
"reconciliationMethod": "END_OF_YEAR",
"spread": "FLAT",
"timing": "IN_ADVANCE",
"earlyPayment": {"unit": "MONTH",
"amount": 0
}
}
]
},
"taxes": ["string"
],
"nonRefundableComponents": ["string"
],
"renewal": {"renewalPeriod": {"amount": 0,
"unit": { }
},
"tacitRenewal": true,
"renewalStopReason": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
},
"renewalQuote": {"components": [{"id": "string",
"premiumRate": 0,
"premium": {"amountPreFeesAndTaxes": 0,
"fees": [{"id": "string",
"brokerageFirmId": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
],
"taxes": [{"id": "string",
"chargeType": "ONE_TIME",
"amount": 0
}
]
}
}
]
},
"crmParameters": {"crmCalculationParameters": {"usage": "TOURING_OR_ALL_PURPOSE"
},
"crmLimitParameters": {"maxCrm": 0,
"crmStopReason": {"reason": "string",
"details": [{"key": "string",
"value": "string"
}
]
}
},
"crmQuoteParameters": {"componentsNotImpacted": ["string"
]
}
}
},
"commonDocuments": [{"type": "string"
}
],
"generatedDocuments": [{"type": "string",
"templateId": "string",
"trigger": ["string"
],
"filters": ["string"
],
"target": "string",
"businessObjects": ["string"
]
}
],
"signature": {"requirePaymentMethodForNewBusiness": true,
"signedDocuments": [{"type": "string",
"signature": "VIEW",
"anchor": {"page": { },
"x": 0,
"y": 0,
"height": 0,
"width": 0
},
"mentions": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"mention": "string"
}
],
"texts": [{"page": { },
"x": 0,
"y": 0,
"width": 0,
"height": 0,
"maxLength": 0,
"question": "string",
"instruction": "string",
"optional": true
}
],
"checkboxes": [{"page": { },
"x": 0,
"y": 0,
"size": 0,
"name": "string",
"optional": true,
"checked": true
}
]
}
]
},
"policyStopReasons": [{"reason": "string",
"details": ["string"
],
"appliedAtDate": "string",
"appliedInFutureAllowed": true,
"refundType": { },
"validForDuration": {"amount": 0,
"unit": { }
}
}
],
"productName": "string"
}

Admin only: Retrieves the rates of a rating table Deprecated

path Parameters

ratingTable

required

string

Responses

Response samples

200
400

Content type

application/json

{"type": "RATING_TABLE",
"id": "string",
"inputs": [{"id": "string",
"unit": "string",
"options": {"includeMin": true,
"includeMax": true
}
}
],
"factors": [{"type": "RATING_FACTORS",
"exactInputs": [{"id": "string",
"value": "string"
}
],
"rangeInputs": [{"id": "string",
"min": 0,
"max": 0
}
],
"value": 0
}
]
}

Admin only: Retrieves an Tiers config Deprecated

Responses

Response samples

200
400
404

Content type

application/json

{"total": 0,
"data": [{"type": "TIER",
"id": "string",
"name": "string",
"basePrice": 0,
"perils": [{"id": "string",
"name": "string"
}
],
"ancillaries": [{"id": "string",
"name": "string"
}
]
}
]
}

Retrieves the list of rating tables Deprecated

Responses

Response samples

200

Content type

application/json

{"total": 0,
"data": [{"type": "RATING_TABLE",
"id": "string",
"inputs": [{"id": "string",
"unit": "string"
}
]
}
]
}

brokerage-firms

Create brokerage firm

Request Body schema: application/json

adminEmail	string The admin email
hostname required	string Hostname attached to the brokerage firm
	object Broker info
orias required	string Orias number
siret required	string Siret number
required	Array of objects (BrokerageFirmFees) Brokerage firm fees by product

Responses

Request samples

Payload

Content type

application/json

{"adminEmail": "string",
"hostname": "string",
"brokerInfo": {"firstName": "string",
"lastName": "string",
"email": "string"
},
"orias": "string",
"siret": "string",
"brokerageFirmFees": [{"productId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
}

Response samples

200
400
404

Content type

application/json

{"type": "string",
"id": "string"
}

List brokerage firms on tenant

Responses

Response samples

200

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"type": "string",
"id": "string",
"orias": "string",
"companyInfo": {"siren": "string",
"siret": "string",
"nafCode": "string",
"nafLabel": "string",
"name": "string",
"creationDate": "string",
"location": {"address": "string",
"postCode": "string",
"city": "string",
"country": "string"
},
"legalStatus": {"1": "string",
"2": "string",
"3": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"brokerageFirmFees": [{"productId": "string",
"brokerFee": 100,
"totalFee": 100
}
],
"tenantId": "string"
}
]
}

Get user's brokerage firm info if it has a brokerage firm

Responses

Response samples

200

Content type

application/json

Example

BrokerAtMeOutput

{"userId": "string",
"firstName": "string",
"lastName": "string",
"brokerageFirmId": "string"
}

Delete brokerage firm Deprecated

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Responses

Response samples

200
404

Content type

application/json

{ }

Update brokerage firm

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Request Body schema: application/json

orias	string Orias number
siret	string Siret number
	Array of objects (BrokerageFirmFees) Brokerage firm fees by product

Responses

Request samples

Payload

Content type

application/json

{"orias": "string",
"siret": "string",
"brokerageFirmFees": [{"productId": "string",
"brokerFee": 100,
"totalFee": 100
}
]
}

Response samples

200
400
404

Content type

application/json

{ }

Get brokerage firm

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Responses

Response samples

200
404

Content type

application/json

{"type": "string",
"id": "string",
"orias": "string",
"companyInfo": {"siren": "string",
"siret": "string",
"nafCode": "string",
"nafLabel": "string",
"name": "string",
"creationDate": "string",
"location": {"address": "string",
"postCode": "string",
"city": "string",
"country": "string"
},
"legalStatus": {"1": "string",
"2": "string",
"3": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"tenantId": "string",
"brokerageFirmFees": [{"productId": "string",
"totalFee": 100,
"brokerFee": 100
}
]
}

Create broker, used only by e2e tests Deprecated

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Request Body schema: application/json

firstName required	string First name
lastName required	string Last name
email	string
brokerUserId required	string User id

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"email": "string",
"brokerUserId": "string"
}

Response samples

200
404

Content type

application/json

{ }

List brokers in brokerage firm

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"firstName": "string",
"lastName": "string",
"email": "string",
"userId": "string"
}
]
}

List broker invites in brokerage firm

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Responses

Response samples

200
404

Content type

application/json

{"data": [{"firstName": "string",
"lastName": "string",
"email": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Delete broker invite in brokerage firm

path Parameters

brokerageFirmId required	string Brokerage firm id
email required	string Invited email

Responses

Response samples

200
404

Content type

application/json

{ }

Get a broker from a brokerage firm

path Parameters

brokerageFirmId required	string Brokerage firm id
brokerUserId required	string Broker user id

Responses

Response samples

200
404

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": [{"firstName": "string",
"lastName": "string",
"email": "string",
"userId": "string"
}
]
}

Delete broker from brokerage firm

path Parameters

brokerageFirmId required	string Brokerage firm id
brokerUserId required	string Broker user id

Responses

Response samples

200
404

Content type

application/json

{ }

Get the platform config of a brokerage firm

path Parameters

brokerageFirmId

required

string

Platform brokerage firm ID

Responses

Response samples

200
404

Content type

application/json

{"logoUrl": "string"
}

Updates the platform config of a brokerage firm

path Parameters

brokerageFirmId

required

string

Platform brokerage firm ID

Request Body schema: application/json

logoUrl

string

Platform logo URL

Responses

Request samples

Payload

Content type

application/json

{"logoUrl": "string"
}

Response samples

200
404

Content type

application/json

{ }

Get policy portfolio

path Parameters

brokerageFirmId

required

string

brokerage firm id

query Parameters

whenAt	string Optional: the whenAt datetime
simulatedAt	string Optional: the simulatedAt datetime
branchId	string Optional: the branchId
count	number the number of items to return
page	number the page to retrieve

Responses

Response samples

200

Content type

application/json

{"data": [{"owners": [{"userId": "string",
"email": "string",
"roles": [{"productId": "string",
"roleId": "string"
}
]
}
],
"id": "string",
"policyStatus": "POLICY_CREATED",
"policyCreatedAt": "string",
"policyStartedAt": "string",
"lastNewBusinessBranchId": "string",
"customerId": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Attach hostname to brokerage firm

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Request Body schema: application/json

hostname

required

string

Hostname

Responses

Request samples

Payload

Content type

application/json

{"hostname": "string"
}

Response samples

200

Content type

application/json

{ }

List hostnames attached to a brokerage firm

path Parameters

brokerageFirmId

required

string

Brokerage firm id

Responses

Response samples

200

Content type

application/json

{"hostnames": ["string"
]
}

Detach hostname from brokerage firm

path Parameters

hostname required	string Hostname
brokerageFirmId required	string Brokerage firm id

Responses

Response samples

200

Content type

application/json

{ }

Get brokerage firm ID from hostname

path Parameters

hostname

required

string

Hostname

Responses

Response samples

200

Content type

application/json

{"brokerageFirmId": "string"
}

wakam

List cities cities from postcode for wakam

path Parameters

postcode

required

string

The postcode to search for

Responses

Response samples

200

Content type

application/json

{"total": 0,
"offset": 0,
"limit": 0,
"data": ["string"
]
}

jobs

Schedule new job

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
service required	string Enum: "DOCUMENTS" "BILLING" "SIGNATURE" "PAYMENTS" "PERMISSIONS" "LEGACY" "METRICS" "JOBS"
command required	string
payload required	object
runAt	string <date-time> The time to schedule the job for
maxAttempts	number The maximum number of attempts to run the job
timeout	number The timeout of the job

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"service": "DOCUMENTS",
"command": "string",
"payload": { },
"runAt": "2019-08-24T14:15:22Z",
"maxAttempts": 0,
"timeout": 0
}

Response samples

200

Content type

application/json

{ }

Update job

path Parameters

jobId

required

string

Request Body schema: application/json

required	Array of objects (Metadata) metadata assigned to the object
service required	string Enum: "DOCUMENTS" "BILLING" "SIGNATURE" "PAYMENTS" "PERMISSIONS" "LEGACY" "METRICS" "JOBS"
command required	string
payload required	object
runAt	string <date-time> The time to schedule the job for
maxAttempts	number The maximum number of attempts to run the job
timeout	number The timeout of the job

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"service": "DOCUMENTS",
"command": "string",
"payload": { },
"runAt": "2019-08-24T14:15:22Z",
"maxAttempts": 0,
"timeout": 0
}

Cancel job

path Parameters

jobId

required

string

Responses

List jobs by metadata

Request Body schema: application/json

required	object the query to search for
	object the page info
	object the sort options
status	string Enum: "CREATED" "RUNNING" "SUCCEEDED" "FAILED" "CANCELLED"

Responses

Request samples

Payload

Content type

application/json

{"query": {"and": [{"key": "string",
"value": "string"
}
],
"or": [{"key": "string",
"value": "string"
}
]
},
"pageInfo": {"count": 0,
"page": 0
},
"order": {"by": "string",
"direction": "string"
},
"status": "CREATED"
}

Clear jobs data

Responses

Clear workflows data

Responses

sra

Fetch list of a given facet

query Parameters

brand	string Optional: The brand code
model	string Optional: The model
version	string Optional: the version
facetName required	string Enum: "brand" "model" "version" "energyCode" "fiscalPower" The facetName possible values
fiscalPower	number >= 1 The fiscalPower value
energyCode	string The energy
entryIntoCirculationDate	string <date-time> The first circulation date

Responses

Response samples

200

Content type

application/json

{"data": ["string"
]
}

Fetch vehicle details

query Parameters

brand required	string The brand
model required	string The model
fiscalPower required	number >= 1 fiscal power
version required	string version
numberOfSeats required	number number of seats

Responses

Response samples

200

Content type

application/json

{"data": [{"id": "string",
"brand": "string",
"model": "string",
"fiscalPower": { },
"energy": { },
"energyCode": { },
"version": "string",
"bodyWork": { }
}
]
}

Get all versions with their fiscal power and number of seats for a given brand and model

query Parameters

brand required	string The brand
model required	string The model

Responses

Response samples

200

Content type

application/json

{"data": [{"version": "string",
"fiscalPower": 0,
"numberOfSeats": 0
}
]
}

claims

Create claim

Request Body schema: application/json

name	string Optional: Name of the entity
description	string
appliedAt	string <date-time>
createdAt	string <date-time>
responsibility	string
category	string
	Array of objects (Metadata) metadata assigned to the object
externalId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"metadata": [{"key": "string",
"value": "string"
}
],
"externalId": "string"
}

Response samples

200
400
409

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"type": { },
"id": "string",
"externalId": "string"
}

List claims

query Parameters

	Array of objects (Metadata) and search
	Array of objects (Metadata) or search
count	number the number of items to return
page	number the page to retrieve
by required	string the sort key
direction required	string the sort direction
externalId required	string

Responses

Response samples

200
400

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"type": { },
"id": "string",
"externalId": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Update claim

path Parameters

id

required

string

Request Body schema: application/json

name	string Optional: Name of the entity
description	string
appliedAt	string <date-time>
createdAt	string <date-time>
responsibility	string
category	string
	Array of objects (Metadata) metadata assigned to the object

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"metadata": [{"key": "string",
"value": "string"
}
]
}

Response samples

200
400
404
409

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"type": { },
"id": "string",
"externalId": "string"
}

Delete claim

path Parameters

id

required

string

Responses

Response samples

200
400
404

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"type": { },
"id": "string",
"externalId": "string"
}

Get claim

path Parameters

id

required

string

Responses

Response samples

200
400
404

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"name": "string",
"description": "string",
"appliedAt": "2019-08-24T14:15:22Z",
"createdAt": "2019-08-24T14:15:22Z",
"responsibility": "string",
"category": "string",
"type": { },
"id": "string",
"externalId": "string"
}

workflows

Schedule workflow execution

Request Body schema: application/json

	Array of objects (Metadata) metadata assigned to the object
payload required	object
required	object (WorkflowDefinitionDto)
runAt	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"payload": { },
"workflow": {"name": "string",
"firstNodeName": "string",
"nodes": ["string"
]
},
"runAt": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"type": "string",
"id": "string"
}

List workflow runs

path Parameters

count	number the number of items to return
page	number the page to retrieve
status	string Enum: "CREATED" "RUNNING" "SUCCEEDED" "FAILED" "CANCELLED" "ERROR"
from	string <date-time>
to	string <date-time>

query Parameters

	Array of objects (Metadata) and search
	Array of objects (Metadata) or search
count	number the number of items to return
page	number the page to retrieve
by required	string the sort key
direction required	string the sort direction

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": "string",
"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"runAt": "2019-08-24T14:15:22Z",
"status": "string",
"attempts": 0,
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"duration": 0,
"currentStep": "string",
"failureMessage": "string"
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Get workflow run

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{"metadata": [{"key": "string",
"value": "string"
}
],
"type": "string",
"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"runAt": "2019-08-24T14:15:22Z",
"status": "string",
"attempts": 0,
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"duration": 0,
"workflow": {"name": "string",
"firstNodeName": "string",
"nodes": ["string"
]
},
"state": { },
"currentStep": "string",
"failureMessage": "string"
}

List workflow run nodes

path Parameters

id required	string
count	number the number of items to return
page	number the page to retrieve

Responses

Response samples

200

Content type

application/json

{"data": [{"metadata": [{"key": "string",
"value": "string"
}
],
"type": "string",
"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"workflowRunId": "string",
"nodeType": "string",
"status": "string",
"attempts": 0,
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"duration": 0,
"node": {"name": "string"
},
"input": { },
"result": { },
"error": {"message": "string",
"stack": "string"
}
}
],
"pageInfo": {"first": true,
"last": true
},
"totalCount": 0,
"currentPage": 0,
"totalPages": 0
}

Cancel workflow run

path Parameters

id

required

string

Responses

Response samples

200

Content type

application/json

{ }

Retry workflow run

path Parameters

id

required

string

Request Body schema: application/json

fromNode

string

Responses

Request samples

Payload

Content type

application/json

{"fromNode": "string"
}

Response samples

200

Content type

application/json

{ }