Schemas

Download schema

ApiResponse

message

string

response

CallbackResult

reference

string

signingStatus

string · enum

Enum values:

NOT_SIGNED

SIGNED_BY_CUSTOMER

SIGNED_BY_INSURER

COMPLETED

PENDING

CANCELLED

object

object[]

object

ContractBundleCreateRequest

applicationId

string · pattern: \S · required

templateIds

string[] · minItems: 1 · required

name

string

attemptCount

integer · int32

ContractBundleUser

string · enum

Enum values:

ADMIN

SALES

ContractCategory

string · enum

Enum values:

MAIN

INSURANCE

OTHER

ContractChangeFlowRequest

applicationId

string

role

string · enum

Enum values:

ADMIN

SALES

ContractDownInput

bundleId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

typeId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

errorMessage

string

ContractFromApplicationRequest

applicationId

string

ContractRegenerateInput

bundleId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

typeId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

ContractSignInput

Provide either contractId alone, or both bundleId and typeId together

fileUrl

string · pattern: \S · required

DMS file URL of the signed document.

contractId

string

Direct contract ID. Takes priority over bundleId + typeId if provided.

bundleId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

Bundle ID. Required when contractId is not provided.

typeId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

Contract type ID. Required when contractId is not provided.

ContractSigningMethod

string · enum

Enum values:

ESIGN

MANUAL

ContractStatus

string · enum

Enum values:

COMPLETED

PENDING

FAILED

ARCHIVED

SIGNED

UNKNOWN

ContractTemplateCreateRequest

name

string · pattern: \S · required

templateTypeId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA… · required

status

string · enum · required

Enum values:

ACTIVE

INACTIVE

DRAFT

ARCHIVED

header

string

content

string

footer

string

object

ContractTemplateDuplicateRequest

contractTemplateId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

name

string

ContractTemplateStatus

string · enum

Enum values:

ACTIVE

INACTIVE

DRAFT

ARCHIVED

ContractTemplateUpdateRequest

id

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

header

string

content

string

footer

string

name

string

typeId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

object

ContractTemplateUpdateStatusRequest

id

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

status

string · enum

Enum values:

ACTIVE

INACTIVE

DRAFT

ARCHIVED

ContractTypeCreateRequest

name

string · minLength: 3 · maxLength: 50 · pattern: \S · required

signingMethod

string · enum · required

Enum values:

ESIGN

MANUAL

category

string · enum · required

Enum values:

MAIN

INSURANCE

OTHER

isRequired

boolean

ContractTypeUpdateRequest

id

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

name

string

signingMethod

string · enum

Enum values:

ESIGN

MANUAL

category

string · enum

Enum values:

MAIN

INSURANCE

OTHER

isRequired

boolean

EsignSigningStatus

string · enum

Enum values:

NOT_SIGNED

SIGNED_BY_CUSTOMER

SIGNED_BY_INSURER

COMPLETED

PENDING

CANCELLED

PagedResponse

array

totalCount

integer · int64

totalPages

integer · int32

currentPage

integer · int32

SignedDocument

type

string

content

string

signingStatus

string

completedAt

string

fileName

string

SignerResult

fullName

string

email

string

phoneNumber

string

idDocumentNumber

string

dateOfBirth

string

hometown

string

idIssuedBy

string

permanentAddress

string

region

string

customerSignedAt

string

insurerSignedAt

string

UUID

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

ContractSignInput

Provide either contractId alone, or both bundleId and typeId together

fileUrl

string · pattern: \S · required

DMS file URL of the signed document.

contractId

string

Direct contract ID. Takes priority over bundleId + typeId if provided.

bundleId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

Bundle ID. Required when contractId is not provided.

typeId

string · uuid · pattern: [a-fA-F0-9]{8}-[a-fA…

Contract type ID. Required when contractId is not provided.