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 relevant inquiry information.

Endpoint

To access the specific inquiry, consumers must initiate an HTTP POST request to the endpoint /api/ipn/inquiry/{:inquiryId} given by the webhook (see V2 Notification ). The inquiryId parameter represents the 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 inquiry

HTTP path

/api/ipn/inquiry/{:inquiryId}

inquiryId - an unique identifier of the requested inquiry

HTTP method

POST

Attributes of the HTTP request

token

string

required

A security token provided from Authentication endpoint.
Required to provide as a Bearer Token (in format: “Bearer {{token}}“).

bToken

string

optional¹

An unique identifier of the broker.

aToken

string

optional¹

An unique identifier of the account.

Explanations:

¹ at least one of bToken and aToken is required in the payload

Attributes of the HTTP response

Success response
sHash	string	required	Security check, if request comes from THINKSURANCE API (see “Security hash generation”)
data	object	required	A root object that holds information on inquiry items. Check Inquiry Scheme bellow.
customer	object	optional	A root object that holds information on customer items. Check Customer Scheme bellow.
docs	array	optional	A root object that holds a list of document metadata items Check Documents Holder Scheme bellow.
Inquiry Scheme
bToken	string	required	Broker specific token in THINKSURANCE system
bExternalId	string	required	Partner’s internal ID for this Broker
iId	int	required	Inquiry ID in THINKSURANCE system
iCreated	string	required	Date of creation of inquiry
iUpdated	string	required	Date of update of inquiry
productName	string	optional	A product’s name on Thinksurance System.
productId	int	optional	A product’s unique identifier on Thinksurance System.
industryId	int	optional	An industry’s unique identifier on Thinksurance System.
professionName	string	optional	A profession’s name on Thinksurance System.
professionId	int	optional	A profession’s unique identifier on Thinksurance System.
status	int	required	Enumeration value that defines the status of an inquiry. Possible values: 2 - tendering (lead) 3 - tendering 4 - calculated 6 - ordered 15 - proposal created
employees	object	optional	A root object that contains information on employees in the insured company. Check Employee Scheme bellow.
revenue	string²	optional	Revenue given in Thinksurance Risk Assessment questionnaire.
bFoundDate	string	optional	Founding date of the broker’s company. MySQL format for date: {{ YYYY-MM-DD }}
taxPercent	int	optional¹	Revenue given in Thinksurance Risk Assessment questionnaire.
contractStartDate	string	optional¹	The starting date of the contract start date. MySQL format for date: {{ YYYY-MM-DD }}
contractPayDate	string	optional¹	The contract’s payment date. MySQL format for date: {{ YYYY-MM-DD }}
insuranceCompanyName	string	optional	Insurance company name selected by Customer/Partner
insuranceCompanyId	int	optional	Insurance company unique identifier on Thinksurance system.
coverage	int²³	optional	Coverage amount for specific insurance company.
deductible	int²	optional	Deductible for specific insurance company
premiumYearly	int⁴	optional¹	Yearly gross premium.
contractDuration	int	optional¹	Contract period in years.
paymentInterval	int	optional¹	Enumeration value that defines the payment interval in months. Possible values: 1 - paid monthly 3 - paid quarterly 6 - paid half yearly 12 - paid yearly
externalReferences	array	optional	An array of objects, containing custom values requested to properly identify the customer on the partners system, for example CRM tool. See External References Scheme bellow.
Employee Scheme
full	string	optional	Number of full time employees given in Thinksurance Risk Assessment questionnaire.
part	string	optional	Number of part time employees given in Thinksurance Risk Assessment questionnaire.
Customer Scheme
cId	int	optional	A customer unique identifier on Thinksurance System.
cExternalId	string	optional	Unique customer’s ID in the partners system.
cSalutation	int	optional	Enumeration value that defines salutation of the customer person: 1 - Mr 2 - Ms
cFirstName	string	optional	Customer person’s first name.
cLastName	string	optional	Customer person’s last name.
cBirthDate	string	optional	Customer person’s date of birth. MySQL format for date: {{ YYYY-MM-DD }}
cEmail	string	optional	Customer person’s email address.
cStreet	string	optional	Customer person’s street name.
cStreetNumber	string	optional	Customer person’s street number.
cZip	string	optional	Customer person’s postcode.
cCity	string	optional	Customer person’s city.
cWebsite	string	optional	Customer person’s website.
cPhone	string	optional	Customer person’s phone number.
cPrivateIsCompanyAddress	int	optional	Enumeration value that defines if customer person’s address should be used as actual business address for the customer: 0 - no, use address from cCompany section 1 - yes
cCompany	string	optional	Customer company’s name.
cCompanyStreet	string	optional	Customer business address street name.
cCompanyStreetNumber	string	optional	Customer business address street number.
cCompanyZip	string	optional	Customer business address postcode.
cCompanyCity	string	optional	Customer business address city.
cExternalReferences	array	optional	An array of objects, containing custom values requested to properly identify the customer on the partners system, for example CRM tool. See External References Scheme bellow.
Documents Holder Scheme
docToken	string	optional⁵	Holder of a token which allows for access to documents per link. Check Documents Token Scheme bellow.
files	array	optional	List of objects. Every document has it’s own object. Check File Scheme bellow.
Documents Token Scheme
token	string	required	Token which allows for access to documents per link.
expired	string	required	Expiration date for document token
File Scheme
name	string	required	The name of the file.
fullName	string	required	The name of the file, including file extension.
hash	string	required	An unique identifier of the file.
fullFilePath	string	required	The link for downloading file.
documentPurpose	string	required	Enumeration value that defines the purpose of the file on Thinksurance System: orderDocument consultationDocument proposalDocument proposalConsultationDocument insurer_docs upload_file questionnaire communicationModule policyDocument Other documents (examples): proposalDocument proposalOrderDocument orderCsvDocument manualPolicyDocument riskAssessmentDocument signSummaryDoc sepaDocument inquiryOrderCsv inquiry_docs inquiry_proposal_docs portfolio_docs export_files broker_imgs pool_docs pool_imgs file_import_template longtext parse-file request_docs proposal_docs ProposalDT …
External References
origin	string	required	Enumeration value that defines to source of the external reference attached to either customer or inquiry: crm - general CRM tool broker_crm - CRM tool from the broker side insurer - a tool provided by the insurer
paramKey	string	required	An unique name of the attribute that holds a value from the CRM tool.
paramValue	string	required	A concrete value of the attribute from the CRM tool.
Explanations: ¹ It is not provided for inquiries in the status 2, 3, 4. ² Value represented in EUR. ³ In some cases (specific products like Firmenrechtsschutz) it could be string(“unbegrenzt”). ⁴ Value represented in CENTS. ⁵ Required if there is at least one file in the list.

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.

HTTP Request with bToken

# HTTP POST
# https://app.dev.thinksurance.de/api/ipn/inq/<some ID>
#
# HTTP headers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
# 
{
  "token": "<some long hash>",
  "bToken": "<some short hash>"
}

HTTP Request with aToken

# HTTP POST
# https://app.dev.thinksurance.de/api/ipn/inq/<some ID>
#
# HTTP headers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
# 
{
  "token": "<some long hash>",
  "aToken": "<some short hash>"
}

Successful HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
    "sHash": "bf02dfa7c7bc64c2cfb5",
    "data": {
        "bToken": "41ba17f637177a0b34d2ac11d",
        "bExternalId": "1",
        "iId": 1878887,
        "iCreated": "2024-03-06",
        "iUpdated": "2024-03-06",
        "productName": "Cyberversicherung",
        "productId": 95,
        "industryName": "Gastronomie",
        "industryId": 113,
        "professionName": "Cafe",
        "professionId": 258,
        "status": 25,
        "iExternalReferences": [
            {
                "origin": "crm",
                "paramKey": "oV-Angebots-Nr",
                "paramValue": "4342344"
            },
            {
                "origin": "crm",
                "paramKey": "oV-Antrags-Nr",
                "paramValue": "4342344"
            },
            {
                "origin": "crm",
                "paramKey": "oV-Deckungskonzept-ID",
                "paramValue": "11052060"
            },
            {
                "origin": "crm",
                "paramKey": "oV-Vertrag-ID",
                "paramValue": "4342343"
            },
            {
                "origin": "crm",
                "paramKey": "oV-Vertrags-Nr",
                "paramValue": "4342345"
            },
            {
                "origin": "crm",
                "paramKey": "oV-Vertragsart-ID",
                "paramValue": "1021640"
            }
        ],
        "employees": {
            "full": "",
            "part": ""
        },
        "revenue": "",
        "bFoundDate": ""
    },
    "customer": {
        "cId": 520108,
        "cExternalId": "9975",
        "cSalutation": "",
        "cTitle": "",
        "cFirstName": "Testuser",
        "cLastName": "cu",
        "cBirthday": "",
        "cEmail": "cust@mer3.com",
        "cCompany": "",
        "cCompanyForm": "",
        "cStreet": "",
        "cStreetNumber": "",
        "cZip": "",
        "cCity": "",
        "cPhone": "",
        "cWebsite": "",
        "cAccountType": 0,
        "cAddressIsCompany": 1,
        "cCompanyStreet": "",
        "cCompanyStreetNumber": "",
        "cCompanyZip": "",
        "cCompanyCity": "",
        "cExternalReferences": [
            {
                "origin": "crm",
                "paramKey": "oV-Kunden-Nr",
                "paramValue": "12345"
            },
            {
                "origin": "crm",
                "paramKey": "oV-Partner-Nr",
                "paramValue": "12345"
            }
        ]
    },
    "docs": {
        "docToken": {
            "token": "<some long hash>",
            "expired": "2024-03-19 09:42:10"
        },
        "files": [
            {
                "name": "dummy_file",
                "fullName": "dummy_file.pdf",
                "hash": "<some hash>",
                "fullFilePath": "<some link>",
                "documentPurpose": "insurer_docs"
            },
            {
                "name": "dummy_document",
                "fullName": "dummy_document.pdf",
                "hash": "<some hash>",
                "fullFilePath": "<some link>",
                "documentPurpose": "upload_file"
            },
            {
                "name": "2090065_Beratungsdokumentation_Betriebshaftpflicht",
                "fullName": "2090065_Beratungsdokumentation_Betriebshaftpflicht.pdf",
                "hash": "<some hash>",
                "fullFilePath": "<some link>",
                "documentPurpose": "consultationDocument"
            },
            {
                "name": "2090065_Deckungsauftrag_Betriebshaftpflicht",
                "fullName": "2090065_Deckungsauftrag_Betriebshaftpflicht.pdf",
                "hash": "<some hash>",
                "fullFilePath": "<some link>",
                "documentPurpose": "orderDocument"
            }
        ]
     }
}

Failed HTTP Response

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "error": "API User is not existing or deactivated."
}

V1 Get IP Notification by Inquiry

Introduction

Endpoint

Attributes of the HTTP request

Attributes of the HTTP response

Examples