Submit answers

POST

/requirements/:requirement_id

POST

/requirements/:requirement_id

$ curl -X POST https://test.api.kota.io/requirements/requirement_id \
>      -H "Authorization: Bearer <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "answers": {
>     "cpr_number": null,
>     "mobile_number": null
>   }
> }'

1 {
2   "status": "fulfilled",
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         "default": "010180-1234",
22         "validation": {
23           "required": true,
24           "rules": [
25             {
26               "rule": {
27                 "match": [
28                   {
29                     "var": "cpr_number"
30                   },
31                   "^\\d{6}-\\d{4}$"
32                 ]
33               },
34               "message": "CPR number must be exactly 10 digits (format: DDMMYY-SSSS)"
35             }
36           ]
37         }
38       },
39       {
40         "id": "mobile_number",
41         "type": "phone",
42         "label": {
43           "default": "Mobile phone number"
44         },
45         "default": "+4520123456",
46         "validation": {
47           "required": true,
48           "rules": [
49             {
50               "rule": {
51                 "phone_valid": [
52                   {
53                     "var": "mobile_number"
54                   },
55                   "DK"
56                 ]
57               },
58               "message": "Please enter a valid mobile phone number"
59             }
60           ]
61         }
62       }
63     ],
64     "flow": {
65       "mode": "auto",
66       "steps": [
67         {
68           "id": "employee_information",
69           "title": {
70             "default": "Employee information"
71           },
72           "fields": [
73             "cpr_number",
74             "mobile_number"
75           ]
76         }
77       ],
78       "navigation": {
79         "start": "employee_information"
80       }
81     }
82   }
83 }

Submit answers for a requirement. Answers are merged with any previously submitted and re-evaluated against the requirement’s schema: it becomes fulfilled once all required fields are satisfied, otherwise it stays in_progress and the response lists the fields still outstanding.

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).

Request

This endpoint expects an object.

answersobjectRequired

A key-value map of field IDs to answer values.

Response

statusenum

The derived submission status. “fulfilled” once the cumulative answers satisfy the whole schema; “in_progress” when answers are stored but the schema is not yet complete; “pending” when no answers are stored.

schemaobject

The requirement schema with the current cumulative answers injected as field defaults, so the client can render the next step (or confirm completion) without a follow-up GET.

outstanding_fieldslist of strings

Field IDs still blocking fulfillment. Present only for an “in_progress” submission.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error