SIAM attributes in Authentication REST API

This page contains information about the user attributes that you can request and retrieve from Signicat IAM (SIAM) when using the Signicat Authentication REST API as an authentication protocol.

Attributes table

Custom attributes

To retrieve the custom attributes you define in your SIAM platform, you need to specify the custom attribute code in the additionalParameters field in the payload of the request to the Create a new session endpoint.

After the authentication flow, you will receive the attribute values in the subject of the session response.

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": [
        "ownidp"
    ],
    "flow": "redirect",
    "requestedAttributes": [
        "firstName",
        "lastName",
        "fullName",
        "middleName",
        "gender",
        "dateOfBirth",
        "company",
        "street",
        "houseNumber",
        "houseNumberSuffix",
        "city",
        "region",
        "postalCode",
        "country",
        "fullAddress",
        "phoneNumber",
        "ninValue",
        "ninType",
        "ninIssuingCountry",
        "custom_member_id"
	],
    "callbackUrls": {
        "success": "https://example.com/success",
        "abort": "https://example.com/abort",
        "error": "https://example.com/error"
	},
    "requestDomain": "<YOUR_SIGNICAT_DOMAIN>"
}

Response example

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

{
    "id": "ab31ed7-b5cb-402e-a989-dcf1d0f7f557",
    "accountId": "a-spge-zRW...XB",
    "authenticationUrl": "https://<YOUR_SIGNICAT_DOMAIN>/broker/sp/external-service/login?messageId=0ef7112f-d292-b042-a289-e42b66f02424&transactionId=3f7ea0c8-97ae-c547-ad5f-a62492ceb0a2",
    "status": "SUCCESS",
    "provider": "ownidp",
    "subject":
    {
        "id": "qyIsCvjlb-UQAjOaH2JJXFXtZj4eXECrTrsexxpBOEI=",
        "firstName": "John",
        "lastName": "Doe",
        "fullName": "John Robert Doe",
        "middleName": "Robert",
        "gender": "male",
        "dateOfBirth": "1985-06-15",
        "company": "Signicat AS",
        "street": "Munkegata",
        "houseNumber": "26",
        "houseNumberSuffix": "B",
        "city": "Trondheim",
        "region": "Trøndelag",
        "postalCode": "7011",
        "country": "Norway",
        "fullAddress": "Munkegata 26B, 7011 Trondheim, Norway",
        "phoneNumber": "+4799999999",
        "ninValue": "15068512345",
        "ninType": "social_security_number",
        "ninIssuingCountry": "NO",
        "custom_member_id": "M12345"
    },
    "callbackUrls":
    {
        "success": "https://example.com:443/success?sessionId=aba31ed7-b5cb-402e-a989-dcf1d0f7f557",
        "abort": "https://example.com:443/abort?sessionId=aba31ed7-b5cb-402e-a989-dcf1d0f7f557",
        "error": "https://example.com:443/error?sessionId=aba31ed7-b5cb-402e-a989-dcf1d0f7f557"
    },
    "environment":
    {
        "ipAddress": "192.0.2.0",
        "userAgent": "userAgent"
    },
    "loa": "low",
    "allowedProviders":
    [
        "ownidp"
    ],
    "language": "en",
    "flow": "redirect",
    "requestedAttributes": 
    [
        "firstName",
        "lastName",
        "fullName",
        "middleName",
        "gender",
        "dateOfBirth",
        "company",
        "street",
        "houseNumber",
        "houseNumberSuffix",
        "city",
        "region",
        "postalCode",
        "country",
        "fullAddress",
        "phoneNumber",
        "ninValue",
        "ninType",
        "ninIssuingCountry",
        "custom_member_id"
    ],
    "sessionLifetime": 1200,
    "expiresAt": "2026-04-30T10:38:50.6756621+00:00"
}