POST
/
search
/
persons
Search for persons
curl --request POST \
  --url https://api.tic.io/search/persons \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '"<any>"'
{
  "facet_counts": [
    {
      "counts": [
        {
          "count": 123,
          "highlighted": "<string>",
          "value": "<string>"
        }
      ],
      "field_name": "<string>",
      "sampled": true,
      "stats": {
        "total_values": 123
      },
      "localizedFieldName": "<string>"
    }
  ],
  "found": 123,
  "hits": [
    {
      "document": {
        "id": "<string>",
        "personId": 123,
        "personalIdentityNumber": "<string>",
        "allIdentities": [
          "<string>"
        ],
        "birthday": "<string>",
        "isProtected": true,
        "isCoordinationNumber": true,
        "givenName": "<string>",
        "firstName": "<string>",
        "middleName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "sex": "male",
        "spar_relationer": [
          {
            "relationstyp": "vardnadshavare",
            "idNummer": "<string>",
            "fodelsedatum": 123,
            "avregistreringsorsakKod": "<string>",
            "avregistreringsdatum": "<string>",
            "avlidendatum": "<string>",
            "forNamn": "<string>",
            "mellanNamn": "<string>",
            "efternamn": "<string>",
            "tilltalsnamn": "<string>"
          }
        ],
        "spar": {
          "notificationRecordId": 123,
          "person_PersonIdTyp": "personnummer",
          "person_SenasteAndringSPAR": 123,
          "skydd_Sekretessmarkering": true,
          "skydd_SekretessmarkeringSattAvSPAR": true,
          "skydd_SekretessDatum": 123,
          "skydd_SkyddadFolkbokforing": true,
          "skydd_SkyddadFolkbokforingDatum": 123,
          "personDetaljer_SnIdentitetsniva": "styrkt",
          "personDetaljer_SnIdentitetsnivaDatum": "<string>",
          "personDetaljer_SnTilldelningsdatum": "<string>",
          "personDetaljer_SnPreliminartVilandeforklaringsdatum": "<string>",
          "personDetaljer_SnFornyelsedatum": "<string>",
          "personDetaljer_SnVilandeorsak": "<string>",
          "personDetaljer_SnVilandeforklaringsdatum": "<string>",
          "personDetaljer_SnAvlidendatum": "<string>",
          "personDetaljer_SnStatus": "<string>",
          "personDetaljer_Sekretessmarkering": true,
          "personDetaljer_SekretessmarkeringSattAvSPAR": true,
          "personDetaljer_Avlidendatum": "<string>",
          "personDetaljer_AntraffadDodDatum": "<string>",
          "personDetaljer_AvregistreringsorsakKod": "<string>",
          "personDetaljer_Avregistreringsdatum": "<string>",
          "personDetaljer_SkyddadFolkbokforing": true,
          "personDetaljer_Fodelsedatum": 123,
          "folkbokforing_FolkbokfordLanKod": "<string>",
          "folkbokforing_FolkbokfordKommunKod": "<string>",
          "folkbokforing_HemvistTyp": "skrivenPaAdressen",
          "folkbokforing_Folkbokforingsdatum": 123,
          "folkbokforing_DistriktKod": "<string>",
          "folkbokforingsadress_SvenskAdress_CareOf": "<string>",
          "folkbokforingsadress_SvenskAdress_Utdelningsadress1": "<string>",
          "folkbokforingsadress_SvenskAdress_Utdelningsadress2": "<string>",
          "folkbokforingsadress_SvenskAdress_PostNr": "<string>",
          "folkbokforingsadress_SvenskAdress_Postort": "<string>",
          "utlandsadress_InternationellAdress_Utdelningsadress1": "<string>",
          "utlandsadress_InternationellAdress_Utdelningsadress2": "<string>",
          "utlandsadress_InternationellAdress_Utdelningsadress3": "<string>",
          "utlandsadress_InternationellAdress_Land": "<string>",
          "sarskildPostadress_SvenskAdress_CareOf": "<string>",
          "sarskildPostadress_SvenskAdress_Utdelningsadress1": "<string>",
          "sarskildPostadress_SvenskAdress_Utdelningsadress2": "<string>",
          "sarskildPostadress_SvenskAdress_PostNr": "<string>",
          "sarskildPostadress_SvenskAdress_Postort": "<string>",
          "sarskildPostadress_InternationellAdress_Utdelningsadress1": "<string>",
          "sarskildPostadress_InternationellAdress_Utdelningsadress2": "<string>",
          "sarskildPostadress_InternationellAdress_Utdelningsadress3": "<string>",
          "sarskildPostadress_InternationellAdress_Land": "<string>",
          "kontaktadress_SvenskAdress_CareOf": "<string>",
          "kontaktadress_SvenskAdress_Utdelningsadress1": "<string>",
          "kontaktadress_SvenskAdress_Utdelningsadress2": "<string>",
          "kontaktadress_SvenskAdress_PostNr": "<string>",
          "kontaktadress_SvenskAdress_Postort": "<string>",
          "kontaktadress_InternationellAdress_Utdelningsadress1": "<string>",
          "kontaktadress_InternationellAdress_Utdelningsadress2": "<string>",
          "kontaktadress_InternationellAdress_Utdelningsadress3": "<string>",
          "kontaktadress_InternationellAdress_Land": "<string>"
        }
      },
      "geo_distance_meters": "<any>",
      "highlight": "<any>",
      "highlights": [
        {
          "field": "<string>",
          "matched_tokens": [
            "<string>"
          ],
          "snippet": "<string>"
        }
      ],
      "text_match": 123,
      "text_match_info": {
        "best_field_score": "<string>",
        "best_field_weight": 123,
        "fields_matched": 123,
        "num_tokens_dropped": 123,
        "score": "<string>",
        "tokens_matched": 123,
        "typo_prefix_score": 123
      }
    }
  ],
  "grouped_hits": {
    "group_key": [
      "<string>"
    ],
    "hits": [
      {
        "document": {
          "id": "<string>",
          "personId": 123,
          "personalIdentityNumber": "<string>",
          "allIdentities": [
            "<string>"
          ],
          "birthday": "<string>",
          "isProtected": true,
          "isCoordinationNumber": true,
          "givenName": "<string>",
          "firstName": "<string>",
          "middleName": "<string>",
          "lastName": "<string>",
          "fullName": "<string>",
          "sex": "male",
          "spar_relationer": [
            {
              "relationstyp": "vardnadshavare",
              "idNummer": "<string>",
              "fodelsedatum": 123,
              "avregistreringsorsakKod": "<string>",
              "avregistreringsdatum": "<string>",
              "avlidendatum": "<string>",
              "forNamn": "<string>",
              "mellanNamn": "<string>",
              "efternamn": "<string>",
              "tilltalsnamn": "<string>"
            }
          ],
          "spar": {
            "notificationRecordId": 123,
            "person_PersonIdTyp": "personnummer",
            "person_SenasteAndringSPAR": 123,
            "skydd_Sekretessmarkering": true,
            "skydd_SekretessmarkeringSattAvSPAR": true,
            "skydd_SekretessDatum": 123,
            "skydd_SkyddadFolkbokforing": true,
            "skydd_SkyddadFolkbokforingDatum": 123,
            "personDetaljer_SnIdentitetsniva": "styrkt",
            "personDetaljer_SnIdentitetsnivaDatum": "<string>",
            "personDetaljer_SnTilldelningsdatum": "<string>",
            "personDetaljer_SnPreliminartVilandeforklaringsdatum": "<string>",
            "personDetaljer_SnFornyelsedatum": "<string>",
            "personDetaljer_SnVilandeorsak": "<string>",
            "personDetaljer_SnVilandeforklaringsdatum": "<string>",
            "personDetaljer_SnAvlidendatum": "<string>",
            "personDetaljer_SnStatus": "<string>",
            "personDetaljer_Sekretessmarkering": true,
            "personDetaljer_SekretessmarkeringSattAvSPAR": true,
            "personDetaljer_Avlidendatum": "<string>",
            "personDetaljer_AntraffadDodDatum": "<string>",
            "personDetaljer_AvregistreringsorsakKod": "<string>",
            "personDetaljer_Avregistreringsdatum": "<string>",
            "personDetaljer_SkyddadFolkbokforing": true,
            "personDetaljer_Fodelsedatum": 123,
            "folkbokforing_FolkbokfordLanKod": "<string>",
            "folkbokforing_FolkbokfordKommunKod": "<string>",
            "folkbokforing_HemvistTyp": "skrivenPaAdressen",
            "folkbokforing_Folkbokforingsdatum": 123,
            "folkbokforing_DistriktKod": "<string>",
            "folkbokforingsadress_SvenskAdress_CareOf": "<string>",
            "folkbokforingsadress_SvenskAdress_Utdelningsadress1": "<string>",
            "folkbokforingsadress_SvenskAdress_Utdelningsadress2": "<string>",
            "folkbokforingsadress_SvenskAdress_PostNr": "<string>",
            "folkbokforingsadress_SvenskAdress_Postort": "<string>",
            "utlandsadress_InternationellAdress_Utdelningsadress1": "<string>",
            "utlandsadress_InternationellAdress_Utdelningsadress2": "<string>",
            "utlandsadress_InternationellAdress_Utdelningsadress3": "<string>",
            "utlandsadress_InternationellAdress_Land": "<string>",
            "sarskildPostadress_SvenskAdress_CareOf": "<string>",
            "sarskildPostadress_SvenskAdress_Utdelningsadress1": "<string>",
            "sarskildPostadress_SvenskAdress_Utdelningsadress2": "<string>",
            "sarskildPostadress_SvenskAdress_PostNr": "<string>",
            "sarskildPostadress_SvenskAdress_Postort": "<string>",
            "sarskildPostadress_InternationellAdress_Utdelningsadress1": "<string>",
            "sarskildPostadress_InternationellAdress_Utdelningsadress2": "<string>",
            "sarskildPostadress_InternationellAdress_Utdelningsadress3": "<string>",
            "sarskildPostadress_InternationellAdress_Land": "<string>",
            "kontaktadress_SvenskAdress_CareOf": "<string>",
            "kontaktadress_SvenskAdress_Utdelningsadress1": "<string>",
            "kontaktadress_SvenskAdress_Utdelningsadress2": "<string>",
            "kontaktadress_SvenskAdress_PostNr": "<string>",
            "kontaktadress_SvenskAdress_Postort": "<string>",
            "kontaktadress_InternationellAdress_Utdelningsadress1": "<string>",
            "kontaktadress_InternationellAdress_Utdelningsadress2": "<string>",
            "kontaktadress_InternationellAdress_Utdelningsadress3": "<string>",
            "kontaktadress_InternationellAdress_Land": "<string>"
          }
        },
        "geo_distance_meters": "<any>",
        "highlight": "<any>",
        "highlights": [
          {
            "field": "<string>",
            "matched_tokens": [
              "<string>"
            ],
            "snippet": "<string>"
          }
        ],
        "text_match": 123,
        "text_match_info": {
          "best_field_score": "<string>",
          "best_field_weight": 123,
          "fields_matched": 123,
          "num_tokens_dropped": 123,
          "score": "<string>",
          "tokens_matched": 123,
          "typo_prefix_score": 123
        }
      }
    ]
  },
  "out_of": 123,
  "page": 123,
  "request_params": {
    "collection_name": "<string>",
    "first_q": "<string>",
    "per_page": 123,
    "q": "<string>"
  },
  "search_cutoff": true,
  "search_time_ms": 123
}
This endpoint is only enabled for customers that passed certain requirements (purpose validation) and has separate throttling enabled.

Authorizations

x-api-key
string
header
required

Body

The body is of type any.

Response

200 - application/json

The search response

The response is of type object.