API Status

Create a person case

The section below describes how to create cases.

How to use

To call the endpoint you will need to perform a HTTP POST request to the URL:

This endpoint takes a JSON body. See the Cases to see the full list of the case properties available.

Example Request

{
    "Forename": "TEST_FORENAME",
    "Surname": "TEST_SURNAME",
    "DayOfBirth": 1,
    "MonthOfBirth": 1,
    "YearOfBirth": 2001,
    "ClientReference": "REST_TEST",
    "HouseNumber": "20",
    "Country": "GBR",
    "Postcode": "CF3 3CA",
    "Type": "Person",
    "OngoingMonitoring":true,
    "Email": "[email protected]",
    "Region":"South East",
    "TaxCode":"123",
    "PlaceOfBirth":"London, United Kingdom",
    "DrivingLicenceNumber":"RUSSF802087TG9EV11",
    "MRZ":"P<CZESPECIMIN<<VZOR<<<<<<<<<<<<<<<<<<<<<<<<<99003853<1CZE1101018M120704611010111<<<<<<94",
    "Gender":"M",
    "Tags": [
        "Person"
    ]
}

Example Response

{
    "caseId": "cd35f8a0-f30c-4cfc-9bcb-12bf58d44876"
}

Language
Credentials
Header
Click Try It! to start a request and see the response here!