Search
K
PMI NCD Lookup API

PMI NCD Lookup API

1.0.0OAS 3.0

Enables the consumer to fetch the NCD(No Claim Discount) level based on the member effective date and the selected underwriting type.

API Base URL
  • Server 1:https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443
Security
oauth2 (oauth2)

Use ‘test-client’ as the client_id and client_secret to obtain a token to access this API.

Fetch the NCD(No Claim Discount) Level.

Consumer must POST request using JSON content-type. Request will consist of a JSON object containing all validScenario, member effective date and the selected underwriting type as per the Models and Examples below.

post
https://ec2-18-202-229-190.eu-west-1.compute.amazonaws.com:8443/v1/pmi/ncdlevel

Headers

Requesting-Systemstringrequired

The system requesting the API, recommended to populate for trace-ability.

Authorizationstringrequired

Authentication credentials for HTTP authentication. Mandatory for secured environments

Default:Bearer 1e23wesryhb667h222hvndmojudsnhh45930044343

Body

application/json

NCDRequest

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

Response

application/json

Returns complete NCD level based on the member effective date and the selected underwriting type

NCDResponse

NCD Level Response

validScenarioboolean

Indicates if the NCD scenario valid or invalid

Allowed values:true

memberarray[object]

Holds the member details

Show Child Parameters
post/v1/pmi/ncdlevel

Body

{ "reunderwriteInd": false, "switchFromType": "Group", "switchType": "Internal", "quoteReference": "PMIQA12234", "member": [ { "isMemberNeeded": 1, "underwritingType": "FMU", "effectiveDate": "2010-03-10", "yearsClaimFree": 0 } ], "isUpliftNeeded": false, "businessType": "N" }
 
application/json

Member

object

Holds the member details

effectiveDatestringrequired

Member effective date. Format e.g YYYY-MM-DD

underwritingTypestringrequired

Member underwriting type. For Virgin Business - FMU/NMORI. For Swicth Business - CMORI/CME/MHD

Allowed values:FMUNMORICMECMORIMHD

yearsClaimFreeinteger(int32)

Number of years that the member has not made a claim. e.g (0, 1, 2)

isMemberNeededinteger(int32)

Indicates whether or not the member will be associated

Allowed values:1

Example