Versions Compared

Version Old Version 10 New Version 11
Changes made by

Marko Milojevic

Marko Milojevic

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To access the specific inquiry, consumers must initiate an HTTP POST request to the endpoint /api/ipn/inquiriesinquiry/{: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/inquiriesinquiry/{:inquiryId}

  • inquiryId - an unique identifier of the requested inquiry

HTTP method

POST

...

This section shows examples of different HTTP requests and responses associated with the endpoint.

HTTP Request with bToken

Code Block
languagejson
# HTTP POST
# https://ipnapp.dev.thinksurance.de/api/ipn/inquiriesinq/<some ID>
#
# HTTP headers
# 'Content-Type': 'application/json'
# 'Accept': 'application/json'
# 'Authorization': 'Bearer <some long string value>'
# 
{
  
{
  "token": "<some long hash>",
  "bToken": "<some someshort encrypted stringhash>"
}

HTTP Request with aToken

Code Block
languagejson
# 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

Code Block
languagejson
# 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": []
}

Failed HTTP Response

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