Get Document types

Description

This service returns a list of all available document types (e.g., DNI, Passport), which is useful for populating dropdown menus in a user interface, as well as handling identity documents as party principals. Identity documents make up a compound data type comprised of a type and a number, separated by a colon (e.g.: "1:1234567"). By default, it returns types for the touchpoint's country, but this can be overridden with an optional parameter.

---

Request

Endpoint

GET https://<server-url>/api/v4/referencedata/documenttypes

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API. Use Thalamus-Token for the header.
activity	Query / Header	Optional. The activity to be used. Use Thalamus-Activity for the header.
countryId	Query	Optional. The ID of a country to retrieve document types for, overriding the touchpoint's default.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v4/referencedata/documenttypes?touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

A JSON array of document type objects is returned for the specified country.

Field	Type	Description
name	String	The name of the document type (e.g., "DNI").
id	Number	The unique identifier for the document type.
countryId	Number	The identifier of the parent country.

JSON

[
  {
    "name": "DNI",
    "id": 1,
    "countryId": 1
  },
  {
    "name": "L. Enrolamiento",
    "id": 2,
    "countryId": 1
  },
  {
    "name": "L. Cívica",
    "id": 3,
    "countryId": 1
  },
  {
    "name": "Pasaporte",
    "id": 4,
    "countryId": 1
  },
  {
    "name": "CI",
    "id": 5,
    "countryId": 1
  }
]