search inquiries

/api/ipn/inquiries

GET

string

required

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

string

optional¹

An unique identifier of the broker.

string

optional¹

An unique identifier of the account.

int

optional

An unique identifier of the inquiry.

int

optional

If defined, only inquiries that were created or updated that last number of days, will be included in the result. Otherwise, inquiries created or updated in last three months will be included.

string

required

Security check, if request comes from THINKSURANCE API (see “Security hash generation”)

object

required

A root object that holds information on inquiry items. Check Inquiry Scheme bellow.

object

optional

A root object that holds information on customer items. Check Customer Scheme bellow.

array

optional

A root object that holds a list of document metadata items Check Document Scheme bellow.

string

required

Broker specific token in THINKSURANCE system

string

required

Partner’s internal ID for this Broker

int

required

Inquiry ID in THINKSURANCE system

string

required

Date of creation of inquiry

string

required

Date of update of inquiry

string

optional

A product’s name on Thinksurance System.

int

optional

A product’s unique identifier on Thinksurance System.

int

optional

An industry’s unique identifier on Thinksurance System.

string

optional

 A profession’s name on Thinksurance System.

int

optional

 A profession’s unique identifier on Thinksurance System.

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

object

optional

A root object that contains information on employees in the insured company. Check Employee Scheme bellow.

string²

optional

Revenue given in Thinksurance Risk Assessment questionnaire.

string

optional

Founding date of the broker’s company.
MySQL format for date: {{ YYYY-MM-DD }}

int

optional¹

Revenue given in Thinksurance Risk Assessment questionnaire.

string

optional¹

The starting date of the contract start date.
MySQL format for date: {{ YYYY-MM-DD }}

string

optional¹

The contract’s payment date.
MySQL format for date: {{ YYYY-MM-DD }}

string

optional

Insurance company name selected by Customer/Partner

int

optional

Insurance company unique identifier on Thinksurance system.

int²³

optional

Coverage amount for specific insurance company.

int²

optional

Deductible for specific insurance company

int⁴

optional¹

Yearly gross premium.

int

optional¹

Contract period in years.

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

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.

string

optional

Number of full time employees given in Thinksurance Risk Assessment questionnaire.

string

optional

Number of part time employees given in Thinksurance Risk Assessment questionnaire.

int

optional

A customer unique identifier on Thinksurance System.

string

optional

Unique customer’s ID in the partners system.

int

optional

Enumeration value that defines salutation of the customer person:

• 1 - Mr

• 2 - Ms

string

optional

Customer person’s first name.

string

optional

Customer person’s last name.

string

optional

Customer person’s date of birth.
MySQL format for date: {{ YYYY-MM-DD }}

string

optional

Customer person’s email address.

string

optional

Customer person’s street name.

string

optional

Customer person’s street number.

string

optional

Customer person’s postcode.

string

optional

Customer person’s city.

string

optional

Customer person’s website.

string

optional

Customer person’s phone number.

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

string

optional

Customer company’s name.

string

optional

Customer business address street name.

string

optional

Customer business address street number.

string

optional

Customer business address postcode.

string

optional

Customer business address city.

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.

string

optional⁵

Holder of a token which allows for access to documents per link. Check Documents Token Scheme bellow.

array

optional

List of objects. Every document has it’s own object. Check File Scheme bellow.

string

required

Token which allows for access to documents per link.

string

required

Expiration date for document token

string

required

The name of the file.

string

required

The name of the file, including file extension.

string

required

An unique identifier of the file.

string

required

The link for downloading file.

string

required

Enumeration value check here Document Purposes

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

string

required

An unique name of the attribute that holds a value from the CRM tool.

string

required

A concrete value of the attribute from the CRM tool.

string

required

It contains a reason for the failed request.

HTTP Request with simple payload

HTTP Request with inquiry identifier

HTTP Request with last days specified

Successful HTTP Response

Failed HTTP Response