Evari · Schema
Evari Contracts Types
InsuranceAustraliaInsurtechPolicy AdministrationCore SystemsProperty and CasualtyUnderwritingClaimsBrokerMGAArtificial IntelligenceQuotingEndorsements
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"definitions": {
"AddressDeclineRequest": {
"properties": {
"address": {
"type": "string"
},
"productId": {
"type": "string"
},
"stateCode": {
"type": "string"
}
},
"required": [
"productId",
"stateCode"
],
"type": "object"
},
"AgentCreateRequest": {
"properties": {
"caLicenseNumber": {
"type": [
"null",
"string"
]
},
"email": {
"format": "email",
"type": "string"
},
"firstName": {
"type": "string"
},
"flLicenseNumber": {
"type": [
"null",
"string"
]
},
"isActive": {
"type": "boolean"
},
"lastName": {
"type": "string"
},
"licenseNumber": {
"type": "string"
},
"metadata": {
},
"organisationId": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"position": {
"type": "string"
},
"role": {
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"shortId": {
"type": [
"null",
"string"
]
},
"txLicenseNumber": {
"type": [
"null",
"string"
]
}
},
"required": [
"email",
"firstName",
"isActive",
"lastName",
"licenseNumber",
"role"
],
"type": "object"
},
"AgentListResponse": {
"properties": {
"items": {
"items": {
"$ref": "#/definitions/AgentResponse"
},
"type": "array"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"items",
"limit",
"offset",
"total"
],
"type": "object"
},
"AgentResponse": {
"properties": {
"caLicenseNumber": {
"type": [
"null",
"string"
]
},
"createdAt": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"flLicenseNumber": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string"
},
"isActive": {
"type": "boolean"
},
"lastName": {
"type": "string"
},
"licenseNumber": {
"type": "string"
},
"licenses": {
"items": {
"$ref": "#/definitions/LicenseResponse"
},
"type": "array"
},
"metadata": {
},
"organisation": {
"$ref": "#/definitions/OrganisationResponse"
},
"phoneNumber": {
"type": "string"
},
"position": {
"type": "string"
},
"shortId": {
"type": [
"null",
"string"
]
},
"txLicenseNumber": {
"type": [
"null",
"string"
]
}
},
"required": [
"createdAt",
"email",
"firstName",
"id",
"isActive",
"lastName",
"licenseNumber",
"licenses"
],
"type": "object"
},
"AgentUpdateRequest": {
"properties": {
"caLicenseNumber": {
"type": [
"null",
"string"
]
},
"email": {
"format": "email",
"type": "string"
},
"firstName": {
"type": "string"
},
"flLicenseNumber": {
"type": [
"null",
"string"
]
},
"isActive": {
"type": "boolean"
},
"lastName": {
"type": "string"
},
"licenseNumber": {
"type": "string"
},
"metadata": {
},
"organisationId": {
"type": "string"
},
"phoneNumber": {
"type": [
"null",
"string"
]
},
"position": {
"type": [
"null",
"string"
]
},
"shortId": {
"type": [
"null",
"string"
]
},
"txLicenseNumber": {
"type": [
"null",
"string"
]
}
},
"type": "object"
},
"AnswerDiff": {
"properties": {
"currentAnswer": {
"type": "string"
},
"endorsementAnswer": {
"type": "string"
},
"question": {
"type": "string"
}
},
"required": [
"currentAnswer",
"endorsementAnswer",
"question"
],
"type": "object"
},
"AttachmentResponse": {
"properties": {
"description": {
"type": [
"null",
"string"
]
},
"fileName": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"description",
"fileName",
"id"
],
"type": "object"
},
"Attestations": {
"properties": {
"dateTimeStamp": {
"type": [
"null",
"string"
]
},
"isAccepted": {
"type": "boolean"
}
},
"required": [
"isAccepted"
],
"type": "object"
},
"AttributeCreateRequest": {
"properties": {
"fieldName": {
"type": "string"
},
"internalDescription": {
"type": "string"
}
},
"required": [
"fieldName",
"internalDescription"
],
"type": "object"
},
"AttributeListRequest": {
"properties": {
"attributeIds": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AttributeResponseItem": {
"properties": {
"fieldName": {
"type": "string"
},
"id": {
"type": "string"
},
"internalDescription": {
"type": "string"
}
},
"required": [
"fieldName",
"id",
"internalDescription"
],
"type": "object"
},
"AttributeResponseItemList": {
"properties": {
"items": {
"items": {
"$ref": "#/definitions/AttributeResponseItem"
},
"type": "array"
},
"total": {
"type": "number"
}
},
"required": [
"items",
"total"
],
"type": "object"
},
"BillingAddressResponse": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"state": {
"type": "string"
},
"streetAddress": {
"type": "string"
},
"zipCode": {
"type": "string"
}
},
"required": [
"city",
"country",
"state",
"streetAddress",
"zipCode"
],
"type": "object"
},
"BillingMethod": {
"enum": [
"CREDITCARD",
"EFT",
"ESCROW"
],
"type": "string"
},
"BulkUpdateStatusItem": {
"properties": {
"statuses": {
"items": {
"$ref": "#/definitions/ClaimUpsertStatusItem"
},
"type": "array"
}
},
"required": [
"statuses"
],
"type": "object"
},
"CancellationPriceComponentResponse": {
"properties": {
"name": {
"type": "string"
},
"source": {
"type": "string"
},
"target": {
"type": "string"
},
"type": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"type",
"value"
],
"type": "object"
},
"CancellationPriceResponse": {
"additionalProperties": {
"type": "string"
},
"properties": {
"premium": {
"type": "string"
},
"totalFees": {
"type": "string"
},
"totalPayable": {
"type": "string"
},
"totalTaxes": {
"type": "string"
}
},
"required": [
"premium",
"totalFees",
"totalPayable",
"totalTaxes"
],
"type": "object"
},
"CancellationReason": {
"enum": [
"CARRIER_CANCELLED",
"INVALID_INFORMATION",
"NO_LONGER_NEEDED",
"OTHER",
"OVERDUE_PAYMENT",
"SWITCHED_INSURER"
],
"type": "string"
},
"ClaimAgent": {
"properties": {
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"id": {
"type": "string"
},
"lastName": {
"type": "string"
},
"phoneNumber": {
"type": [
"null",
"string"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName",
"phoneNumber"
],
"type": "object"
},
"ClaimAnswer": {
"properties": {
"answerValue": {
"format": "cowboy",
"type": [
"null",
"string"
]
},
"questionId": {
"format": "uuidv4",
"type": "string"
}
},
"required": [
"answerValue",
"questionId"
],
"type": "object"
},
"ClaimAnswerResponseItem": {
"properties": {
"answerText": {
"format": "cowboy",
"type": [
"null",
"string"
]
},
"answerValue": {
"format": "cowboy",
"type": [
"null",
"string"
]
},
"group": {
"format": "cowboy",
"type": [
"null",
"string"
]
},
"label": {
"format": "cowboy",
"type": "string"
},
"questionId": {
"format": "uuidv4",
"type": "string"
}
},
"required": [
"answerText",
"answerValue",
"group",
"label",
"questionId"
],
"type": "object"
},
"ClaimAttachmentResponse": {
"properties": {
"claimId": {
"type": "string"
},
"description": {
"type": [
"null",
"string"
]
},
"fileName": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"description",
"fileName",
"id"
],
"type": "object"
},
"ClaimAttachmentUpdateRequest": {
"properties": {
"description": {
"type": "string"
},
"fileName": {
"type": "string"
}
},
"type": "object"
},
"ClaimAttestationResponse": {
"properties": {
"attestationText": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"id": {
"type": "string"
},
"productId": {
"type": "string"
}
},
"required": [
"attestationText",
"createdAt",
"id",
"productId"
],
"type": "object"
},
"ClaimAvailableStatusResponseItem": {
"properties": {
"questions": {
"items": {
"$ref": "#/definitions/ClaimQuestionResponse"
},
"type": "array"
},
"status": {
"type": "string"
},
"statusId": {
"format": "uuidv4",
"type": "string"
}
},
"required": [
"questions",
"status",
"statusId"
],
"type": "object"
},
"ClaimAvailableStatusesResponseList": {
"properties": {
"items": {
"items": {
"$ref": "#/definitions/ClaimAvailableStatusResponseItem"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
},
"ClaimCreateAttestationRequest": {
"properties": {
"attestationText": {
"format": "cowboy",
"type": "string"
},
"productId": {
"format": "uuidv4",
"type": "string"
}
},
"required": [
"attestationText",
"productId"
],
"type": "object"
},
"ClaimCreateQuestionItem": {
"properties": {
"dataType": {
"$ref": "#/definitions/ClaimQuestionDataType"
},
"group": {
"type": [
"null",
"string"
]
},
"helpText": {
"type": [
"null",
"string"
]
},
"internalKey": {
"type": "string"
},
"label": {
"type": "string"
},
"maxValue": {
"type": [
"null",
"number"
]
},
"minValue": {
"type": [
"null",
"number"
]
},
"options": {
"anyOf": [
{
"items": {
"$ref": "#/definitions/ClaimQuestionAnswerOption"
},
"type": "array"
},
{
"type": "null"
}
]
},
"placeholder": {
"type": "string"
},
"referenceKey": {
"type": [
"null",
"string"
]
},
"required": {
"type": "boolean"
}
},
"required": [
"dataType",
"internalKey",
"label",
"placeholder",
"required"
],
"type": "object"
},
"ClaimCreateQuestionsRequest": {
"properties": {
"questions": {
"items": {
"$ref": "#/definitions/ClaimCreateQuestionItem"
},
"type": "array"
}
},
"required": [
"questions"
],
"type": "object"
},
"ClaimCreateRequest": {
"properties": {
"answers": {
"items": {
"$ref": "#/definitions/ClaimAnswer"
},
"type": "array"
},
"attachmentIds": {
"format": "uuidv4",
"items": {
"type": "string"
},
"type": "array"
},
"attestationAccepted": {
"type": "boolean"
},
"details": {
"format": "cowboy",
"type": "string"
},
"fnolSubmittedDate": {
"format": "isoDateString",
"type": "string"
},
"incidentDate": {
"format": "isoDateString",
"type": "string"
},
"policyId": {
"format": "uuidv4",
"type": "string"
},
"productId": {
"format": "uuidv4",
"type": "string"
}
},
"required": [
"answers",
"attestationAccepted",
"details",
"incidentDate",
"policyId",
"productId"
],
"type": "object"
},
"ClaimCreateStatusItem": {
"properties": {
"colorHex": {
"format": "hexColor",
"type": "string"
},
"label": {
"format": "cowboy",
"type": "string"
},
"rank": {
"format": "positiveInt",
"type": "number"
}
},
"required": [
"label"
],
"type": "object"
},
"ClaimCreateStatusUpdateRequest": {
"properties": {
"answers": {
"items": {
"$ref": "#/definitions/ClaimAnswer"
},
"type": "array"
},
"statusId": {
"format": "uuidv4",
"type": "string"
}
},
"required": [
"statusId"
],
"type": "object"
},
"ClaimCreateStatusUpdateResponse": {
"properties": {
"answers": {
"items": {
"$ref": "#/definitions/ClaimAnswer"
},
"type": "array"
},
"claimId": {
"format": "uuidv4",
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"answers",
"claimId",
"status"
],
"type": "object"
},
"ClaimCustomer": {
"properties": {
"email": {
"type": [
"null",
"string"
]
},
"firstName": {
"type": [
"null",
"string"
]
},
"id": {
"type": "string"
},
"lastName": {
"type": [
"null",
"string"
]
},
"phoneNumber": {
"type": [
"null",
"string"
]
}
},
"required": [
"email",
"firstName",
"id",
"lastName",
"phoneNumber"
],
"type": "object"
},
"ClaimEmailRequest": {
"properties": {
"emailAddresses": {
"format": "email",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"emailAddresses"
],
"type": "object"
},
"ClaimEmailResponse": {
"properties": {
"emailAddresses": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"emailAddresses"
],
"type": "object"
},
"ClaimEventListItem": {
"properties": {
"eventDate": {
"type": "string"
},
"eventType": {
"type": "string"
},
"id": {
"type": "string"
}
},
"required": [
"eventDate",
"eventType",
"id"
],
"type": "object"
},
"ClaimEventListResponse": {
"properties": {
"items": {
"items": {
"$ref": "#/definitions/ClaimEventListItem"
},
"type": "array"
},
"limit": {
"type": "number"
},
"startDate": {
"type": [
"null",
"string"
]
}
},
"required": [
"items",
"limit",
"startDate"
],
"type": "object"
},
"ClaimFromAllowedDomainsResponse": {
"properties": {
"domains": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"domains"
],
"type": "object"
},
"ClaimFromEmailRequest": {
"properties": {
"emailAddress": {
"format": "email",
"type": "string"
}
},
"required": [
"emailAddress"
],
"type": "object"
},
"ClaimFromEmailResponse": {
"properties": {
"emailAddress": {
"type": "string"
}
},
"required": [
"emailAddress"
],
"type": "object"
},
"ClaimListItem": {
"properties": {
"agent": {
"anyOf": [
{
"$ref": "#/definitions/ClaimAgent"
},
{
"type": "null"
}
]
},
"customer": {
"anyOf": [
{
"$ref": "#/definitions/ClaimCustomer"
},
{
"type": "null"
}
]
},
"fnolSubmittedDate": {
"type": "string"
},
"id": {
"type": "string"
},
"incidentDate": {
"type": "string"
},
"policy": {
"$ref": "#/definitions/ClaimPolicy"
},
"status": {
"type": "string"
},
"statusColorHex": {
"type": [
"null",
"string"
]
}
},
"required": [
"agent",
"customer",
"fnolSubmittedDate",
"id",
"incidentDate",
"policy",
"status",
"statusColorHex"
],
"type": "object"
},
"ClaimListResponse": {
"properties": {
"items": {
"items": {
"$ref": "#/definitions/ClaimListItem"
},
"type": "array"
},
"limit": {
"type": "number"
},
"offset": {
"type": "number"
},
"total": {
"type": "number"
}
},
"required": [
"items",
"limit",
"offset",
"total"
],
"type": "object"
},
"ClaimPolicy": {
"properties": {
"id": {
"type": "string"
},
"product": {
"anyOf": [
{
"$ref": "#/definitions/ClaimPolicyProduct"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"product"
],
"type": "object"
},
"ClaimPolicyProduct": {
"properties": {
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ClaimQuestionAnswerOption": {
"properties": {
"internalKey": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"internalKey",
"value"
],
"type": "object"
},
"ClaimQuestionDataType": {
"enum": [
"CURRENCY",
"DECIMAL",
"DROPDOWN",
"INTEGER",
"STRING",
"YEAR",
"YESNO"
],
"type": "string"
},
"ClaimQuestionRespon
# --- truncated at 32 KB (339 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/evari/refs/heads/main/json-schema/evari-contracts-types.json