Get a requirement

GET

/requirements/:requirement_id

GET

/requirements/:requirement_id

$ curl https://test.api.kota.io/requirements/requirement_id \
>      -H "Authorization: Bearer <apiKey>"

1 {
2   "is_fulfilled": false,
3   "schema": {
4     "id": "enrolment_in_dansksundhedssikring",
5     "version": 1,
6     "object_type": "employee",
7     "benefit_type": "health",
8     "context": "enrolment_intent",
9     "title": {
10       "default": "Employee information required"
11     },
12     "datasets": [],
13     "fields": [
14       {
15         "id": "cpr_number",
16         "type": "text",
17         "label": {
18           "default": "CPR number"
19         },
20         "placeholder": "e.g. 010180-1234",
21         "validation": {
22           "required": true,
23           "rules": [
24             {
25               "rule": {
26                 "match": [
27                   {
28                     "var": "cpr_number"
29                   },
30                   "^\\d{6}-\\d{4}$"
31                 ]
32               },
33               "message": "CPR number must be exactly 10 digits (format: DDMMYY-SSSS)"
34             }
35           ]
36         }
37       },
38       {
39         "id": "mobile_number",
40         "type": "phone",
41         "label": {
42           "default": "Mobile phone number"
43         },
44         "validation": {
45           "required": true,
46           "rules": [
47             {
48               "rule": {
49                 "phone_valid": [
50                   {
51                     "var": "mobile_number"
52                   },
53                   "DK"
54                 ]
55               },
56               "message": "Please enter a valid mobile phone number"
57             }
58           ]
59         }
60       }
61     ],
62     "flow": {
63       "mode": "auto",
64       "steps": [
65         {
66           "id": "employee_information",
67           "title": {
68             "default": "Employee information"
69           },
70           "fields": [
71             "cpr_number",
72             "mobile_number"
73           ]
74         }
75       ],
76       "navigation": {
77         "start": "employee_information"
78       }
79     }
80   }
81 }

Retrieve a requirement’s current state and the schema of the fields it needs. The response reports whether the requirement has already been fulfilled (and when), and includes the JSON Schema describing the fields to collect.

Path parameters

requirement_idstringRequiredformat: "^ar_[0-9a-f]{32}$"

A requirement identifier in the format ar_ followed by 32 lowercase hex characters (e.g. ar_0a1b2c3d4e5f67890a1b2c3d4e5f6789).

Response

is_fulfilledboolean

Whether this requirement has already been fulfilled.

fulfilled_atdatetime

When the requirement was fulfilled. Present only when fulfilled.

schemaobject

A JSON Schema object describing the fields required for this requirement. Present for pending requirements and may also be returned for fulfilled requirements.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error