Search
K
PMI NCD Lookup API

NCDRequest

object

NCD Level Request

reunderwriteIndboolean

Indicates the underwriting type

Allowed values:true

switchTypestring

Indicate switch type

Allowed values:InternalExternal

memberarray[object]required

Holds the member details

Show Child Parameters
quoteReferencestring

Indicates Quote Reference Number

businessTypestringrequired

Indicates whether a new or switch business.

switchFromTypestring

Indicates the switch from type

Allowed values:GroupIndividual

isUpliftNeededboolean

indicates whether or not the ncd uplift will be associated(needs to be passed as true if we need uplifted value from BRE for New Business)

Allowed values:true

Example

NCDResponse

object

NCD Level Response

validScenarioboolean

Indicates if the NCD scenario valid or invalid

Allowed values:true

memberarray[object]

Holds the member details

Show Child Parameters
Example

ProblemDetail

object

Problem detail exception.

typestring

An absolute URI [RFC3986] that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

titlestring

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localisation.

statusstring

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detailstring

An human readable explanation specific to this occurrence of the problem.

instancestring

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

codestring

This is an Aviva extension type that could be used for sending common mapped business error codes back to the consumer

Example