Endpoints

Current endpoints available in the Insolventiemonitor.nl API.

All Relations

GET https://api.insolventiemonitor.nl/api/v1/dev/relations

This endpoint allows you to get a list of all relations

Headers

Name	Type	Description
X-API-Key	string	Api key

202 Succesfully fetched relations

    "message": "Succesfully fetched relations",
    "response": [
        {
            "ID": "831c17e8-1f85-40a2-8548-9872c86f8fe1",
            "CreatedAt": "2021-03-01T19:39:16.68947Z",
            "UpdatedAt": "2021-04-28T11:27:14.582229Z",
            "DeletedAt": null,
            "CompanyName": "Jouwkabel.nl B.V.",
            "CocNumber": "63893436",
            "VatNumber": "",
            "VatCheckDate": null,
            "TrackResults": null,
            "LastInsolvencyCheck": "2021-03-01T20:30:09.797955Z",
            "InsolventieRecords": null,
            "LastPublicationsCheck": "2021-04-26T22:27:17.431973Z",
            "KvkPublicatiesRercords": null,
            "LastLocationsCheck": "2021-04-26T19:43:34.164195Z",
            "KvkVestigingen": null
        }
    ],
    "succesfull": true
}

401 Invalid X-API-key header, or just forbidden.

Get Relation

GET https://api.insolventiemonitor.nl/api/v1/dev/relation/:uuid

Select a specific relation with the underlaying dataset.

Query Parameters

Name	Type	Description
uuid	string	uuid of specific relation

Headers

Name	Type	Description
X-API-Key	string	Api key

202

{
    "message": "Succesfully fetched relation",
    "response": {
        "ID": "831c17e8-1f85-40a2-8548-9872c86f8fe1",
        "CreatedAt": "2021-03-01T19:39:16.68947Z",
        "UpdatedAt": "2021-04-28T11:27:14.582229Z",
        "DeletedAt": null,
        "CompanyName": "REFERENCE BV",
        "CocNumber": "12345678",
        "VatNumber": "",
        "VatCheckDate": null,
        "TrackResults": [
            {
                "ID": "0dc8488b-b632-4c47-9976-7eb8d7ae2bf2",
                "CreatedAt": "2021-03-01T19:39:16.784702Z",
                "UpdatedAt": "2021-04-28T11:27:14.591053Z",
                "DeletedAt": null,
                "TrackID": "831c17e8-1f85-40a2-8548-9872c86f8fe1",
                "TrackType": "INFO",
                "StatusMessage": "Relatie aangemaakt op 2021-03-01",
                "RelationValid": true,
                "Status": ""
            },
            {
                "ID": "2aa3d608-fc0e-4c0c-a67c-2427877c6b8f",
                "CreatedAt": "2021-03-01T20:00:09.520021Z",
                "UpdatedAt": "2021-04-28T11:27:14.583755Z",
                "DeletedAt": null,
                "TrackID": "831c17e8-1f85-40a2-8548-9872c86f8fe1",
                "TrackType": "INSOLVENTIE",
                "StatusMessage": "Op basis van het KvK nummer vonden wij een hit in het insolventie register: REFERENCE",
                "RelationValid": false,
                "Status": ""
            }
        ],
        "LastInsolvencyCheck": "2021-03-01T20:30:09.797955Z",
        "InsolventieRecords": [
            {
                "CreatedAt": "2021-03-01T20:00:09.531238Z",
                "UpdatedAt": "2021-04-28T11:27:14.594776Z",
                "DeletedAt": null,
                "RelationID": "831c17e8-1f85-40a2-8548-9872c86f8fe1",
                "InsolventieKenmerk": "REFERENCE",
                "PublicatieDatum": "0001-01-01T00:00:00Z",
                "KvkNummer": "12345678",
                "HandelsNaam": "REFERENCE BV"
            }
        ],
        "LastPublicationsCheck": "2021-04-26T22:27:17.431973Z",
        "KvkPublicatiesRercords": [],
        "LastLocationsCheck": "2021-04-26T19:43:34.164195Z",
        "KvkVestigingen": []
    },
    "succesfull": true
}

400

404

Create new relation

POST https://api.insolventiemonitor.nl/api/v1/dev/relations

Headers

Name	Type	Description
Content-Type	string	application/json
X-API-Key	string	Api Key

Request Body

Name	Type	Description
VATnumber	string	VAT number such as NL00000000
COCnumber	string	Chamber of Commerce number
CompanyName	string	Name of your relation

202

{
    "message": "Succesfully created relation, we have scheduled checking task, if the're are any problems, you'll receive a notification by webhook or email.",
    "response": {
        "ID": "17f94649-88c8-4a81-b599-bb956d93bd6f",
        "CreatedAt": "2021-05-01T10:08:17.625945+02:00",
        "UpdatedAt": "2021-05-01T10:08:17.625945+02:00",
        "DeletedAt": null,
        "CompanyName": "EXAMPLE BV",
        "CocNumber": "12345678",
        "VatNumber": "",
        "VatCheckDate": null,
        "TrackResults": null,
        "LastInsolvencyCheck": null,
        "InsolventieRecords": null,
        "LastPublicationsCheck": null,
        "KvkPublicatiesRercords": null,
        "LastLocationsCheck": null,
        "KvkVestigingen": null
    },
    "succesfull": true
}

400

409