Data API

The /customer-api Data API is used to get or delete stored logs. The following endpoints and method types are used to access the Data API.

For all requests to the Data API, if the company uses a Secret Key supplied by IDkollen, that secret key should be used as a Bearer Token. Both the Api-key and the Secret Key can be found in the Admin section at the bottom of the page.

Get all TeleID logs:

GET https://api.idkollen.se/customer-api/{api-key}/teleid

Response example:

HTTP/2.0 200 OK

{
    "pno": "199604032384",
    "dateTime": "2022-01-26T13:05:40",
    "autodeleteDate": "2022-07-25",
    "agentName": "Agent name",
    "bankIdToken": "f4c1d82e-e396-4c8b-bc52-5151bc019da5",
    "endUserName": "Rosalinainho Vaktelsson",
    "certStartDate": "2022-01-04",
    "bankIdNumber": null,
    "address": null,
    "phone": null
}

Delete all TeleID logs:

DELETE https://api.idkollen.se/customer-api/{api-key}/teleid

Response example:

HTTP/2.0 200 OK

5 posts deleted

Delete TeleID logs between certain dates. fromDate and toDate should be formatted to the YYYY-MM-DD pattern:

DELETE https://api.idkollen.se/customer-api/{api-key}/inbox/from/{fromDate}/to/{toDate}/

Response example:

HTTP/2.0 200 OK
2 posts deleted

Get all TeleSign logs:

GET https://api.idkollen.se/customer-api/{api-key}/teleid

Response example:

HTTP/2.0 200 OK

{
    "pno": "199604032384",
    "dateTime": "2022-01-26T13:05:40",
    "text": "TeleSign text message",
    "email": "test@domain.com",
    "autodeleteDate": "2022-07-25",
    "agentName": "Agent name",
    "bankIdToken": "f4c1d82e-e396-4c8b-bc52-5151bc019da5",
    "endUserName": "Rosalinainho Vaktelsson",
    "certStartDate": "2022-01-04",
    "bankIdNumber": null,
    "address": null,
    "phone": null
}

Delete all TeleSign logs:

DELETE https://api.idkollen.se/customer-api/{api-key}/teleid

Response example:

HTTP/2.0 200 OK
5 posts deleted

Delete TeleSign logs between certain dates. fromDate and toDate should be formatted to the YYYY-MM-DD pattern:

DELETE https://api.idkollen.se/customer-api/{api-key}/inbox/from/{fromDate}/to/{toDate}/

Response example:

json title="HTTP/2.0 200 OK"
2 posts deleted

Get all Sent Message logs:

GET https://api.idkollen.se/customer-api/{api-key}/messages

Response example:

HTTP/2.0 200 OK

{
    "id": "0709520e-549e-4e6b-b0d1-552519g6505a",
    "creationDatetime": "2022-01-05T12:05:49",
    "pno": "199604032384",
    "subject": "Testing",
    "body": "Test text",
    "displayName": "Rosalinainho Vaktelsson",
    "attachment": null,
    "email": "test@domain.com",
    "requestSignature": false,
    "messageSigned": false,
    "recipients": null
}

Get attachment for a certain Sent Message by messageId:

GET https://api.idkollen.se/customer-api/{api-key}/message/{messageId}/attachment

Response example:

HTTP/2.0 200 OK
Response contains the file attachment

Delete all Sent Message logs:

DELETE https://api.idkollen.se/customer-api/{api-key}/messages

Response example:

HTTP/2.0 200 OK
3 posts deleted

Delete Sent Message logs between certain dates. fromDate and toDate should be formatted to the YYYY-MM-DD pattern.

DELETE https://api.idkollen.se/customer-api/{api-key}/messages/from/{fromDate}/to/{toDate}/

Get all inbox (sent FormID forms) logs:

GET https://api.idkollen.se/customer-api/{api-key}/inbox

Response example:

HTTP/2.0 200 OK

{
    "id": "04a67c31-9df1-47c1-a551-41abdacd6023",
    "pno": "199604032384",
    "userDisplayName": "Rosalinainho Vaktelsson",
    "input": {
        "clientnr": "testClientNr",
        "Telephone": "testPhone",
        "message": "testMessage",
        "Fil": "testFile",
        "Check": "true"
    },
    "status": "New",
    "datetime": "2022-02-07T11:44:57",
    "formId": 4,
    "bankIdToken": "e45e2420-fbc8-4490-a9cb-14b32dp743f9",
    "filename": null,
    "responded": false,
    "formName": "testform1"
}

Get attachment for a certain inbox (sent FormID forms) by messageId:

GET https://api.idkollen.se/customer-api/{api-key}/inbox/{messageId}/attachment

Response example:

json title="HTTP/2.0 200 OK"
Response contains the file attachment

Delete all inbox (sent FormID forms) logs:

DELETE https://api.idkollen.se/customer-api/{api-key}/inbox

Response example:

HTTP/2.0 200 OK
4 posts deleted

Delete inbox (sent FormID forms) logs between certain dates. fromDate and toDate should be formatted to the YYYY-MM-DD pattern:

DELETE https://api.idkollen.se/customer-api/{api-key}/inbox/from/{fromDate}/to/{toDate}/

Response example:

HTTP/2.0 200 OK
2 posts deleted

Get autoDelete information:

GET https://api.idkollen.se/customer-api/{api-key}/info/autodelete

Response example:

HTTP/2.0 200 OK

{
    "teleidTeleSignAutoDeleteDays": 180,
    "gdprFormNameToAutoDeleteDaysMap": {
        "testform1": 180,
        "test2": 0,
        "test3": 0
    }
}

Get information about what company users are connected to what services:

GET https://api.idkollen.se/customer-api/{api-key}/info/users

Response example:

HTTP/2.0 200 OK

{
    "teleIdUsers": [
        {
            "username": "199604032384",
            "displayName": "Rosalinainho Vaktelsson"
        },
        {
            "username": "199712212399",
            "displayName": "Klasinho Talgoxesson"
        }
    ],
    "teleSignUsers": [
        {
            "username": "199604032384",
            "displayName": "Rosalinainho Vaktelsson"
        },
        {
            "username": "199712212399",
            "displayName": "Klasinho Talgoxesson"
        }
    ],
    "safeMailUsers": [
        {
            "username": "199604032384",
            "displayName": "Rosalinainho Vaktelsson"
        },
        {
            "username": "199712212399",
            "displayName": "Klasinho Talgoxesson"
        }
    ]
}