Example Request

Following is a JSON example of a typical request object. This JSON object must be submitted via POST method to the API endpoint. Please see the JSONAPI specification for more details.

{
    "data": {
        "attributes": {
            "current_address": {
                "city": "London",
                "country": "United Kingdom",
                "first_date_of_residence": "11/2014",
                "last_date_of_residence": "09/2015",
                "postcode": "T35ER",
                "premise": "123",
                "street": "Example Road"
            },
            "day_of_birth": "09",
            "driving_license": {
                "number": "exampl-123456-ab1-ab"
            },
            "forename": "David",
            "gender": "Male",
            "id3_check_level": "advanced",
            "id3_password": "my_id3_account_password123",
            "id3_profile_id": "12345-432j1-2342d-8259-d4bc69f40dd8",
            "id3_username": "[email protected]",
            "middlename": "Thomas",
            "month_of_birth": "02",
            "national_insurance": {
                "number": "ex-01-01-01-a"
            },
            "passport": {
                "day_of_expiry": "31",
                "month_of_expiry": "12",
                "number": "01232345-5-gbr-123415-m-123415-01",
                "year_of_expiry": "2026"
            },
            "previous_addresses": [
                {
                    "city": "LONDON",
                    "country": "United Kingdom",
                    "first_date_of_residence": null,
                    "last_date_of_residence": null,
                    "postcode": "T351ER",
                    "premise": "FLAT 1, BUILDING 9",
                    "street": "ANOTHER EXAMPLE STREET"
                },
                {
                    "city": "LONDON",
                    "country": "United Kingdom",
                    "first_date_of_residence": null,
                    "last_date_of_residence": null,
                    "postcode": "T351ER",
                    "premise": "FLAT 2, BUILDING 9",
                    "street": "ANOTHER EXAMPLE STREET"
                }
            ],
            "reference": "my testing check",
            "surname": "Example",
            "title": "Mr",
            "year_of_birth": "1987"
        },
        "type": "id3-check"
    }
}