Page Comparison

...

To search for a list of inquiries belonging to the specific broker, consumers should send a HTTP POST GET request to endpoint /api/ipn/get/{:token}. The token parameter represents the security token acquired during the Authentication process on the API (see V1 Authentication)inquiries. As essential components of the JSON payload within the body of the request, consumers are required to include bToken (functioning as the broker identifier).

Action name

search inquiries

HTTP path

/api/ipn/get/{:token}

token - the security token acquired during the Authentication process

inquiries

HTTP method

POSTGET

Attributes of the HTTP request

HTTP Request Header

bToken

Authorization	string	required

An unique identifier of the broker.

iId

A security token provided from Authentication endpoint. Required to provide as a Bearer Token (in format: “Bearer {{token}}“).
X-Broker-Token	string	optional¹	An unique identifier of the broker.
X-Account-Token	string	optional¹	An unique identifier

of an inquiry.

of the account.

HTTP GET parameters

inquiryId

int

optional

An unique identifier of the inquiry.

lastDays

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.

Explanations:

Anchor

	request
	request

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

Attributes of the HTTP response

...

HTTP Request with simple payload

Code Block

language	json

# HTTP POSTGET
# https://appipn.dev.thinksurance.de/api/ipn/get/<some long hash>
inquiries
#
# HTTP headers
# 'Content-TypeAccept': 'application/json'
# 'AcceptAuthorization': 'application/json'
# 
{
  "bToken": "<some encrypted string>"
}Bearer <some long string value>'
# 'X-Broker-Token': '<some hash>' 
#

HTTP Request with inquiry identifier

Code Block

language	json

# HTTP POSTGET
# https://appipn.dev.thinksurance.de/api/ipn/get/<some long hash>
inquiries?inquiryId=123456
#
# HTTP headers
# 'Content-TypeAccept': 'application/json'
# 'AcceptAuthorization': 'application/json'
# 
{
  "bToken": "<some encrypted string>",
  "iId": 123456
}Bearer <some long string value>'
# 'X-Broker-Token': '<some hash>'
#

HTTP Request with last days specified

Code Block

language	json

# HTTP POSTGET
# https://appipn.dev.thinksurance.de/api/ipn/get/<some long hash>
inquiries?inquiryId=123456&lastDays=1
#
# HTTP headers
# 'Content-TypeAccept': 'application/json'
# 'AcceptAuthorization': 'application/json'
# 
{
  "bToken": "<some encrypted string>",
  "lastDays": 1 #includes results from today and yesterday
}Bearer <some long string value>'
# 'X-Broker-Token': '<some hash>'
#

Successful HTTP Response

Code Block

language	json

# HTTP 200 status code
# 'Content-Type': 'application/json'
{
  "123456": {
    "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

Code Block

language	json

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

Versions Compared

Old Version 1

New Version 2

Key

Attributes of the HTTP request

Attributes of the HTTP response