| Table of Contents |
|---|
Introduction
To obtain the payload of a specific inquiry, the Thinksurance Public API V2, denoted as "the API," offers a specialised endpoint. This endpoint allows consumers to retrieve all releveant relevant inquiry information.
Endpoint
To access the specific documentinquiry, consumers must initiate an HTTP POST request to the href endpoint /api/ipn/inquiry/{:inquiryId} given by the webhook (see V2 Notification ). The token inquiryId parameter represents the security token acquired during the Authentication process on the API (see Authentication ) unique identifier of an inquiry. As essential components of the JSON payload within the body of the request, consumers are required to include the token and bToken (functioning as the broker identifier) or aToken (functioning as the account identifier).
Action name | get documentinquiry |
|---|---|
HTTP path | /api/ipn/inquiry/{{inquiry_id}} please use href as given in the specific webhook:inquiryId}
|
HTTP method | POST |
Attributes of the HTTP request
token | string | required |
|---|
A security token provided from Authentication endpoint. | |
bToken | string |
|---|
Success response
optional1 | An unique identifier of the broker. | ||
aToken | string | optional1 | An unique identifier of the account. |
|---|
Attributes of the HTTP response
HTTP Request
Explanations: |
|---|
sHash
String
required
Security check, if request comes from THINKSURANCE API (see “Security hash generation”)
data
bToken
String
required
Broker specific token in THINKSURANCE system
bExternalId
String
required
Partner’s internal ID for this Broker
iId
Integer
required
Inquiry ID in THINKSURANCE system
iCreated
String
required
Date of creation of inquiry
iUpdated
String
required
Date of update of inquiry
productName
String
Product name THINKSURANCE system
productId
Integer
Product ID in THINKSURANCE system
industryId
Integer
professionName
String
professionId
Integer
status
Integer
required
Status of the inquiry. Possible values: 2 – Deal break (Lead) 3 – Deal break, 4 – Calculated, 6 – Booked 15 – Proposal created
Employees
Array
Number of employees of the insured person Format: [“full”: XX,“part”: YY]
Employees - full
String
Number of full time employees given in THINKSURANCE risk questionaire
Employees - part
String
Number of part time employees given in THINKSURANCE risk questionaire
revenue
String (Euro)
Revenue given in THINKSURANCE risk questionaire
bFoundDate
String (date)
Founding date of the broker’s company Format: DD.MM.YYYY
taxPercent
Integer ('%)
Tax. Will be not provided in case status is 2, 3, 4
contractStartDate
String
Contract start date. Will be not provided in case status is 2, 3, 4 Format: DD.MM.YYYY (Example: 01.01.2019)
contractPayDate
String (Date)
Contract payment date. Will be not provided in case status is 2, 3, 4 Format: DD.MM.YYYY (Example: 01.01.2019)
insuranceCompanyName
String
Insurance company name selected by Customer/Partner
insuranceCompanyId
Integer
Insurance company ID in THINKSURANCE system
coverage
Integer (euro)
Coverage amount for specific insurance company Note: In some cases(specific products like Firmenrechtsschutz) it could be string(“unbegrenzt”)
deductible
Integer (euro)
Deductible for specific insurance company
premiumYearly
Integer
(cents)
Yearly gross premium. Will be not
provided in case status is 2, 3, 4
contractDuration
Integer
Contract period in years Will be not provided in case status is 2, 3, 4 (Example: 1)
paymentInterval
Integer
Payment interval in months Will be not provided in case status is 2, 3, 4. Possible values [1, 3, 6, 12]
customer
cId
Integer
Thinksurance Customer System ID
cExternalId
String
Customer ID in partner-system to be uniquely identified
cSalutation
String
Customer Salutation: . Values: [1,2] 1 – Herr, 2 – Frau, 3 - Divers
cTitle
String
Not used in plattform anymore
cFirstName
String
Customer’s given name
cLastName
String
Customer’s family name
cBirthday
String
Customer’s birthdate.: "YYYY-MM-DD"
cEmail
String
Customer’s Email adress
cCompany
String
customer’s company
cCompanyForm
String
Legal form of customer’s company., Values: [1-10], 1 – AG, 2 – Einzelunternehmen, 3 – GbR, 4 – GmbH, 5 – GmbH & Co KG, 6 – KG, 7 – Ltd., 8 – OHG, 9 – UG (haftungsbeschränkt), 10 - Sonstige Rechtsform
cStreet
String
Customer’s adress – street name
cStreetNumber
String
Customer’s adress – street number
cZip
String
Customer’s adress – postcode
cCity
String
Customer’s adress – city name
cPhone
String
Customer’s phone number
cWebsite
String
Customer’s web site
cAccountType
String
Differentiates customer between corporate (0) and private entity (1)
cAdressIsCompany
Integer
Does the customer’s address equal the business adress? 0 – No 1 – Yes
cCompanyStreet
Integer
Object’s address (company address if
different) – street name
cCompanyStreetNumber
String
Object’s address (if different) – street number
cCompanyZip
String
Object’s address (if different) – post code
cCompanyCity
String
Object’s address (if different) – city
docs
docsToken
Array
token
String
Token which allows for access to documents per Link
expired
String
Experation date for document token
files
Array
Object of the document. Every document has it’s own object.
Failed response
error
string
required
It contains a reason for the failed request.
Examples
This section shows examples of different HTTP requests and responses associated with the endpoint.
1 at least one of bToken and aToken is required in the payload | |||||||||
|---|---|---|---|---|---|---|---|---|---|
Attributes of the HTTP response
Examples
This section shows examples of different HTTP requests and responses associated with the endpoint.
HTTP Request with bToken | |||||
| |||||
HTTP Request with aToken | |||||
| |||||
Successful HTTP Response | |||||
| |||||
Failed HTTP Response | |||||
|