Endpoints

The following are the endpoints used by the Pet Insurance Quote & Buy solution:

  • FTOS_INSQB_ApplyUWRules: This endpoint applies the underwriting formula from the product, and returns true/false, in case the UW result is "Passed" or "Not Passed".

  • FTOS_INSQB_GenerateMandate: This endpoint calls the mandate generation for direct debits, through openAPI.

  • FTOS_INSQB_GeneratePolicy: Read about this endpoint here.

  • FTOS_INSQB_GetDNTAvailableQuestions: Read about this endpoint here.

  • FTOS_INSQB_GetConfiguredCards: Read about this endpoint here.

  • FTOS_INSQB_SaveDNTAnswers: Read about this endpoint here.

  • FTOS_INSQB_SelectFinalCard: Read about this endpoint here.

Parameter Description
policyList List of policies to generate; Multiple policies can be generated at once.
insuranceTypeName The name of an insurance type configured in the system, in FTOS_IP_InsuranceType entity.
productCode Insurance product code
insuranceProductItemList List of items to be included on the policy.
code Item code.
insuredAmount Item insured amount.
finalPremiumAmount Item premium amount.
issuedDate Date of issuance, basic format ISO 8601 YYYY-MM-DD.
startDate Policy begin date, basic format ISO 8601 YYYY-MM-DD.
renewedPolicyNo Old policy number, in case of renewal.
quoteNo Quote number.
totalIndemnityLimit Total indemnity limit on the policy.
validityType Type of validity. Months value supported in the first version of the API.
validity How many years/ months/ days the insurer sets this policy to be valid for. Value "12" is supported in the first version of the API.
agent Object containing the agent details.
agentId Agent Id.
type Type of the agent issuing the policy - Individual person or Legal person.
broker Object containing broker details.
brokerId Broker Id.
contractor Area containing contractor details.
uniqueIdentifier CNP or CUI, depending on the contractor’s type.
type Contractor type - Individual person or Legal person.
firstName Contractor first name.
lastName Contractor last name.
insured Area containing insured details.
uniqueIdentifier CNP or CUI, depending on the insured type.
type Insured type - Individual person or Legal person.
firstName Insured first name.
lastName Insured last name.
beneficiary Area containing beneficiary details.
uniqueIdentifier CNP or CUI, depending on the beneficiary type
type Beneficiary type - Individual person or Legal person.
firstName Beneficiary first name.
lastName Beneficiary last name.
currency Currency.
paymentType

Payment type. It can take these values:

OP for bank transfers, PayU for PayU transfers, PayU-on time for PayOnTime transfers, brokerCollection for Broker Collection type transfers.
paymentFrequency Number of installments on the policy.
mentions Special mentions at Policy level.
Copy 
{
    "policyList": [{
        "insuranceTypeName": "",
        "productCode": "",
        "insuranceProductItemList": [{
            "code": "",
            "insuredAmount": "",
            "finalPremiumAmount": ""
        }],
        "issuedDate": "",
        "startDate": "",
        "renewedPolicyNo": "",
        "quoteNo": "",
        "totalIndemnityLimit": "",
        "validityType": "",
        "validity": "",
        "agent": {
            "agentId": "",
            "type": ""
        },
        "broker": {
            "brokerId": ""
        },
        "contractor": {
            "uniqueIdentifier": "",
            "type": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": ""
        },
        "insured": {
            "uniqueIdentifier": "",
            "type": "",
            "firstName": ""
        },
        "beneficiary": {
            "uniqueIdentifier": "",
            "type": "",
            "firstName": "",
            "lastName": "",
            "email": "",
            "phone": ""
        },
        "currency": "",
        "paymentType": "",
        "paymentFrequency": "",
        "mentions": "",
        "exchangeRate": 
    }]
}
Code Text Description
ERR06.01

ERR06.01 - Invalid issued date!

 

 Issue date value provided on issuedDate key is less than current date
ERR06.02 ERR06.02 - Invalid start date! Start date value provided on startDate key is less than or equal with issuedDate value
ERR06.03 ERR06.03 - Invalid paymentType! Value provided on paymentType key is not valid (not part of the accepted values)
ERR06.05 ERR06.05 - Invalid currency! Currency code provided on currency key is not identifed
ERR06.08 ERR06.08 - Existing policy for the same quote and insurance type! Another policy of the same insurance type is already registered