Skip to main content
POST
Creates a new Policy record.

Authorizations

X-App-Id
string
header
required

App ID authentication. Enter your App ID below.

X-Api-Key
string
header
required

API Key authentication. Enter your key below.

Body

organizationId
integer<int32>
required
memberId
integer<int32>
required
policyNumber
string
required
Required string length: 1 - 50
coverageType
string
required
Required string length: 1 - 100
sumInsured
number<double>
required
Required range: 0 <= x <= 1000000000
deductibleAmount
number<double>
required
Required range: 0 <= x <= 1000000000
premiumAmount
number<double>
required
Required range: 0 <= x <= 1000000000
startDate
string<date-time>
required
endDate
string<date-time>
required
currencyCode
string | null
Maximum string length: 10
paymentFrequency
enum<integer>
Available options:
1,
2,
3,
4,
5
status
enum<integer>
Available options:
1,
2,
3,
4,
5

Response

OK

id
integer<int32>
organizationId
integer<int32>
organizationName
string | null
memberId
integer<int32>
memberNumber
string | null
memberFullName
string | null
policyNumber
string | null
coverageType
string | null
sumInsured
number<double>
deductibleAmount
number<double>
premiumAmount
number<double>
currencyCode
string | null
paymentFrequency
enum<integer>
Available options:
1,
2,
3,
4,
5
startDate
string<date-time>
endDate
string<date-time>
status
enum<integer>
Available options:
1,
2,
3,
4,
5
createdAt
string<date-time>
updatedAt
string<date-time> | null