Tenant API - Registered letters

Get response details

Get the response status of a registered letter sent by a tenant. A user can sign a registered letter or let it expire.

When a user signs a registered letter, it is removed from their account, and the response is stored. If the letter is not signed before its expiration date, it is automatically removed as well. In both cases the response is stored.

When sending a registered letter a sender_reference can be included. This is an optional field that can be used to store an internal reference with the registered letter. This field is included when fetching the response of a registered letter.

get/v2/tenant/{tenantKey}/registered/{responseKey}

Request

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

Path parameters

tenantKeystring hexadecimal required

The unique tenant key that the registered letters belong to.

responseKeystring hexadecimal required

The unique key of a registered letter response.

Response

The registered letter response.

status'signed' | 'expired'

Status of the registered letter response.

signed_atstring ISO8601 nullable

When the registered letter was signed

sender_referenceobject nullable

The same object that was passed by the sender when creating the registered letter. Null if nothing was passed.

content_keystring
bank_id_orderobject nullable

Returns the same as the BankID collect endpoint, however bankIdIssueDate, uhi and risk are excluded.

Example response

{
  "signed_at": "2025-06-15T12:00:10Z",
  "sender_reference": {
    "internal_id": "6eb7d1b9-ccd6-408f-ade7-9a1837be3ecf"
  },
  "content_key": "2877d684-a340-4e4c-867f-d93283787b01",
  "bank_id_order": {
    "orderRef": "0197b142-2c15-74a7-9850-3b68087ad4ec",
    "status": "completed",
    "completionData": {
      "user": {
        "personalNumber": "197701032380",
        "name": "Jan-Erik Karlsson",
        "givenName": "Jan-Erik",
        "surname": "Karlsson"
      },
      "device": {
        "ipAddress": "142.250.74.206"
      },
      "stepUp": {
        "mrtd": false
      },
      "signature": "PD94bWwgdmVyc2lvb...",
      "ocspResponse": "MIIHdgoBAKCCB28wggdrBg..."
    }
  }
}

Changes

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