For the complete documentation index, see llms.txt

Authentication REST API

This page contains information about the user attributes that you can request and retrieve with the EUDI Wallet through the Signicat Authentication REST API.

Attributes table

Examples

Request example

To create a session using the Authentication REST API, you send a POST request to the Create a new session endpoint of the Authentication REST API. This is https://api.signicat.com/auth/rest/sessions.

You define the parameters of the session in the payload of the request. For example:

{
  "allowedProviders": [
    "wallet-verifier"
  ],
  "language": "en",
  "flow": "redirect",
  "requestedAttributes": [
      "firstName",
      "lastName",
      "dateOfBirth",
      "gender",
      "nin",
      "address",
      "nationality",
      "email",
      "walletVerifierDateOfExpiry",
      "walletVerifierDateOfIssuance",
      "walletVerifierPersonalAdministrativeNumber",
      "walletVerifierIssuingAuthority",
      "walletVerifierIssuingCountry",
      "walletVerifierDocumentNumber",
      "walletVerifierIssuingJurisdiction",
      "walletVerifierTrustAnchor",
      "walletVerifierAttestationLegalCategory",
      "walletVerifierPlaceOfBirthLocality",
      "walletVerifierPlaceOfBirthRegion",
      "walletVerifierPlaceOfBirthCountry"
  ],
  "callbackUrls": {
    "success": "https://example.com/success",
    "abort": "https://example.com/abort",
    "error": "https://example.com/error"
  },
}

Response example

The following is an example of a response showing the end-user information attributes:

{
    "id": "efacd04b-9e84-4328-b8ae-a4cc59bb4b28",
    "accountId": "<YOUR_SIGNICAT_ACCOUNT_ID>",
    "authenticationUrl": "https://<YOUR_SIGNICAT_DOMAIN>/broker/sp/external-service/login?messageId=3b03d4b1-da85-8f42-85f5-e14a826a4496&transactionId=4fce3e52-e779-a645-ac40-d70a39913b7c",
    "status": "SUCCESS",
    "provider": "wallet-verifier",
    "subject": {
        "id": "-KawNflomN6v649lT3Y-cwdJvmweDbsp-NyT9xflM8U=",
        "firstName": "Anna",
        "lastName": "Johansson",
        "dateOfBirth": "1990-07-22",
        "email": "anna.johansson@example.com",
        "address": "Kungsportsavenyen 25, 411 36 Gothenburg, Sweden",
        "addressFormatted": {
            "FullAddress": "Kungsportsavenyen 25, 411 36 Gothenburg, Sweden",
            "Street": "Kungsportsavenyen",
            "HouseNumber": "25",
            "City": "Gothenburg",
            "Region": "Vastra Gotaland",
            "PostalCode": "411 36",
            "Country": "SE"
        },
        "gender": "2",
        "nationality": "SE,NO"
    },
    "callbackUrls": {
        "success": "https://example.com:443/get?status=success&sessionId=efacd04b-9e84-4328-b8ae-a4cc59bb4b28",
        "abort": "https://example.com:443/get?status=abort&sessionId=efacd04b-9e84-4328-b8ae-a4cc59bb4b28",
        "error": "https://example.com:443/get?status=error&sessionId=efacd04b-9e84-4328-b8ae-a4cc59bb4b28"
    },
    "environment": {
          "ipAddress": "192.0.2.0",
          "userAgent": "userAgent"
    },
    "loa": "unspecified",
    "allowedProviders": [
        "wallet-verifier"
    ],
    "flow": "redirect",
    "requestedAttributes": [
        "firstName",
        "lastName",
        "dateOfBirth",
        "gender",
        "nin",
        "address",
        "nationality",
        "email",
        "walletVerifierDateOfExpiry",
        "walletVerifierDateOfIssuance",
        "walletVerifierPersonalAdministrativeNumber",
        "walletVerifierIssuingAuthority",
        "walletVerifierIssuingCountry",
        "walletVerifierDocumentNumber",
        "walletVerifierIssuingJurisdiction",
        "walletVerifierTrustAnchor",
        "walletVerifierAttestationLegalCategory",
        "walletVerifierPlaceOfBirthLocality",
        "walletVerifierPlaceOfBirthRegion",
        "walletVerifierPlaceOfBirthCountry"
    ],
    "sessionLifetime": 1200,
    "expiresAt": "2026-08-12T14:37:20.1905445+00:00"
}