Tenant API - Forms

Get form template

Given a tenant key and a form template key returns the form template that the tenant created.

get/v2/tenant/{tenantKey}/form/{formTemplateKey}

Request

  • Base URL: https://sender.api.kivra.com
  • URL: https://sender.api.kivra.com/v2/tenant/{tenantKey}/form/{formTemplateKey}
  • Auth: oAuth2Client (defined in the document in a form this page cannot read)

Path parameters

tenantKeystring hexadecimal required

The unique key for a tenant for whom the form template belongs to

formTemplateKeystring uuid required

The form template key associated with the form template

Response

Form template

titlestring required

The title of the form.

descriptionstring required

The purpose of the form.

start_questionstring required

The id of the first question in questions that will be asked to the user.

keystring uuid required

The key of the newly created form template.

created_atstring required

The date the form template was created.

versioninteger required

The form template version

Example response

{
  "title": "Customer KYC",
  "description": "Your bank has some questions",
  "start_question": "number_deposits",
  "questions": [
    {
      "label": "How many times per month do you deposit into your account?",
      "id": "number_deposits",
      "type": "number",
      "next_question": "largest_sum"
    },
    {
      "label": "What is the largest amount deposited?",
      "id": "largest_sum",
      "type": "options",
      "options": [
        {
          "id": "small",
          "label": "10000 - 20000"
        },
        {
          "id": "medium",
          "label": "20000 - 30000"
        },
        {
          "id": "large",
          "label": "30000 - 40000",
          "next_question": "source"
        }
      ],
      "next_question": "citizenship"
    },
    {
      "label": "Select your country of citizenship",
      "id": "citizenship",
      "type": "multi_options",
      "options": [
        {
          "id": "swe",
          "label": "Sweden"
        },
        {
          "id": "no",
          "label": "Norway"
        },
        {
          "id": "dk",
          "label": "Denmark"
        }
      ],
      "min": 1,
      "max": 2,
      "next_question": "comments"
    },
    {
      "label": "What is the source of the deposit?",
      "id": "source",
      "type": "free_text",
      "next_question": "account"
    },
    {
      "label": "Select your salary account",
      "id": "account",
      "type": "verified_account",
      "next_question": "comments"
    },
    {
      "label": "Do you have any further comments?",
      "id": "comments",
      "type": "free_text",
      "help_text": "This can be any type of feedback that you have."
    }
  ],
  "key": "2877d684-a340-4e4c-867f-d93283787b01",
  "created_at": "2022-11-23T14:51:23.874434Z",
  "version": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.