Skip to content
KivraAPI Reference
This is a new version of the Kivra Developer Docs. Report issues or share feedback at avsandare.support@kivra.se. The previous version can be found here.

Get form response

GET
/v2/tenant/{tenantKey}/form/{formTemplateKey}/responses/{formResponseKey}
curl --request GET \
  --url https://sender.api.kivra.com/v2/tenant/example/form/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/responses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Only the client that created the form template associated with the response can call this endpoint.

Given a tenant key, form template key and form response key returns the form response submitted by a user.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantKey
required
string format: hexadecimal

The unique key for a tenant for whom the form response belongs to.

formTemplateKey
required
string format: uuid

The form template key associated with the form template.

formResponseKey
required
string format: uuid

The form response key associated with the form response.

Responses

Section titled “Responses”

200

Section titled “200”

Form response

Media typeapplication/json
FormResponse
object
form_response_key
required

The form response key

string format: uuid
form_template_key
required

The form template key.

string format: uuid
response

The form response that the user submitted.

Array<object>
object
id

A key used to identify the question.

string
value

The response to the question.

object
key
additional properties
One of:
string
type

The input type required to answer the question.

free_text is a string.

number is an integer.

options can be a string or an integer.

multi_options is a list of options.

verified_account an object containing account information.

string
Allowed values: free_text number options multi_options
matched_by
required

Used to identify the user that answered the form

object
type
required

How the user that answered the form was identified.

string
Allowed values: ssn email
value
required

Represents a value used to identify a user e.g. ssn or email.

string
login_method
required

How the user that submitted the form logged into Kivra

string
Allowed values: bankid
responded_at
required

When Kivra received a response to the form

string format: ISO8601
sender_reference
required

Provided reference data in content sendout is included in the form response.

object
Example
{
  "form_response_key": "2877d684-a340-4e4c-867f-d93283787b01",
  "form_template_key": "2877d684-a340-4e4c-867f-d93283787b01",
  "response": [
    [
      {
        "id": "number_deposits",
        "value": 1,
        "type": "number"
      },
      {
        "id": "largest_sum",
        "value": "small",
        "type": "options"
      },
      {
        "id": "comments",
        "value": "No further comments",
        "type": "free_text"
      },
      {
        "id": "account",
        "type": "verified_account",
        "value": {
          "account_number": "1234-5678",
          "bank_name": "Bank",
          "clearing_number": "1234"
        }
      },
      {
        "id": "citizenship",
        "type": "multi_options",
        "value": [
          "Swedish",
          "German"
        ]
      }
    ]
  ],
  "matched_by": {
    "type": "ssn",
    "value": 199202286837
  },
  "login_method": "bankid",
  "responded_at": "2023-08-22T12:39:29.000000Z",
  "sender_reference": {
    "internal_id": "6eb7d1b9-ccd6-408f-ade7-9a1837be3ecf"
  }
}

400

Section titled “400”

Can’t process the request. Likely due to a client error.

401

Section titled “401”

Not authorized to make the request

403

Section titled “403”

Forbidden from accessing the form response keys

404

Section titled “404”

Either the form template associated with the given formTemplateKey does not exist or the form response associated with the given responseKey does not exist.