Example Request

Search…
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.
1
{
2
    "data": {
3
        "attributes": {
4
            "current_address": {
5
                "city": "London",
6
                "country": "United Kingdom",
7
                "first_date_of_residence": "11/2014",
8
                "last_date_of_residence": "09/2015",
9
                "postcode": "T35ER",
10
                "premise": "123",
11
                "street": "Example Road"
12
            },
13
            "day_of_birth": "09",
14
            "driving_license": {
15
                "number": "exampl-123456-ab1-ab"
16
            },
17
            "forename": "David",
18
            "gender": "Male",
19
            "id3_check_level": "advanced",
20
            "id3_password": "my_id3_account_password123",
21
            "id3_profile_id": "12345-432j1-2342d-8259-d4bc69f40dd8",
22
            "id3_username": "[email protected]",
23
            "middlename": "Thomas",
24
            "month_of_birth": "02",
25
            "national_insurance": {
26
                "number": "ex-01-01-01-a"
27
            },
28
            "passport": {
29
                "day_of_expiry": "31",
30
                "month_of_expiry": "12",
31
                "number": "01232345-5-gbr-123415-m-123415-01",
32
                "year_of_expiry": "2026"
33
            },
34
            "previous_addresses": [
35
                {
36
                    "city": "LONDON",
37
                    "country": "United Kingdom",
38
                    "first_date_of_residence": null,
39
                    "last_date_of_residence": null,
40
                    "postcode": "T351ER",
41
                    "premise": "FLAT 1, BUILDING 9",
42
                    "street": "ANOTHER EXAMPLE STREET"
43
                },
44
                {
45
                    "city": "LONDON",
46
                    "country": "United Kingdom",
47
                    "first_date_of_residence": null,
48
                    "last_date_of_residence": null,
49
                    "postcode": "T351ER",
50
                    "premise": "FLAT 2, BUILDING 9",
51
                    "street": "ANOTHER EXAMPLE STREET"
52
                }
53
            ],
54
            "reference": "my testing check",
55
            "surname": "Example",
56
            "title": "Mr",
57
            "year_of_birth": "1987"
58
        },
59
        "type": "id3-check"
60
    }
61
}
Copied!
AML - Previous
Next - AML
Response
Last modified 2yr ago
Copy link