{
   "userInfoType":"User info type",
   "userInfo":"User information corresponding to user info type",
   "attributesToReturn":[
      {
         "attribute":"Type of attribute to be returned"
      }
   ],
   "minRegistrationLevel":"Minimum required registration level of a user",
   "userConfirmationMethod":"Method used to confirm user's identity"
}

userInfoType: string, mandatory. Describes the type of user information supplied to identify the end user. For QR code login should be set to INFERRED. Here the user does not type anything, they initiate authentication by using their device to scan the QR code presented to them on the login page of your service.

userInfo: If userInfoType is INFERRED, then userInfo must be set to: "N/A" because there is no data for the user to enter (see example below).

minRegistrationLevel: string, optional. Minimum required registration level of a user in order to approve/decline authentication. Can be BASIC, EXTENDED or PLUS. If not present, default level will be BASIC.

userConfirmationMethod: string, optional. Used to specify the method by which the user's identity is confirmed when performing an action. Can be DEFAULT or DEFAULT_AND_FACE.

{
   "authRef":"Authentication reference",
   "status":"Authentication status",
   "requestedAttributes":{
      "basicUserInfo":{
         "name":"User's name",
         "surname":"User's surname"
      },
      "emailAddress":"User's primary email address",
      "allEmailAddresses":[
         {
            "emailAddress":"User's email address"
         },
         {
            "emailAddress":"User's email address"
         }
      ],
      "allPhoneNumbers":[
        {
            "phoneNumber":"User's phone number"
        },
        {
            "phoneNumber":"User's phone number"
        }
      ],   
      "dateOfBirth":"User's date of birth",
      "age":"User's age",
      "photo":"User's photo, Base64 encoded JPEG bytes",
      "addresses":[
         {
            "country":"Country",
            "city":"City",
            "postCode":"Postal code",
            "address1":"Street, number or equivalent",
            "address2":"Street, number or equivalent",
            "address3":"Street, number or equivalent",
            "validFrom":"Date from which the address is valid",
            "type":"Type of user's address",
            "sourceType":"Source from which the address is obtained"
         }
      ],
      "customIdentifier":"Custom identifier set by the RP",
      "ssn":{
         "ssn":"Social security number of the end user",
         "country":"Country of SSN"
      },
      "document" : {
         "type":"Type of document used for registration e.g. passport",
         "country":"Document issuing country",
         "serialNumber":"Document serial number",
         "expirationDate":"Document expiration date"
      },
      "documentPhoto":"Document photo, Base64 encoded JPEG bytes",
      "registrationLevel":"User's registration level in Freja eID",
      "relyingPartyUserId":"Unique user ID reserved for Relying Parties",
      "integratorSpecificUserId":"Unique user ID reserved for Integrators",
      "details":"JWS signed data, see below"
}

authRef: string, mandatory. The authentication reference of the authentication.

status: string, mandatory. One of:

• STARTED (the transaction has been started but not yet delivered to Freja eID application associated with the end user),
• DELIVERED_TO_MOBILE (the Freja eID app has downloaded the transaction),
• CANCELED (the end user declined the authentication request),
• RP_CANCELED (the authentication request was sent to the user but cancelled by the RP before the user could respond),
• EXPIRED (the authentication request was not approved by the end user within the authentication validity limit of two minutes),
• APPROVED (the authentication was successful) or
• REJECTED (e.g. if you try to run more than one authentication transaction for the same user at the same time).

requestedAttributes: JSON object (see below), optional. Provides additional attributes about a user if required in attributestToReturn parameter in related initAuthRequest and the status was equal to APPROVED.

details: JWS signed object (see below), optional. Provides details and evidence of the authentication if status was equal to APPROVED.

JWS in compact serialised form as following:

BASE64URL(UTF8(JWS Protected Header)) || ’.’ || BASE64URL(JWS Payload) || ’.’ || BASE64URL(JWS Signature)

JWS Protected Header

{
   "x5t":"SHA-1 digest of the signing certificate",
   "alg":"algorithm used to secure the JWS"
}

x5t: mandatory, Base64URL encoding of the certificate's SHA-1 digest.

alg: mandatory, the value shall be RS256 which corresponds to 'RSA PKCS#1 signature with SHA-256'.

JWS Payload

{
   "authRef":"Authentication reference",
   "status":"Authentication status",
   "userInfoType":"User info type",
   "userInfo":"User information corresponding to user info type",
   "minRegistrationLevel":"Minimum required registration level of a user",
   "requestedAttributes":{
       JSON object, see below.   
       },    
      "timestamp":"Time when authentication is confirmed by end user"
}

authRef: See authRef above.

status: See status above.

userInfoType: INFERRED

userInfo: N/A

minRegistrationLevel: See minRegistrationLevel as described in Initiate authentication method.

requestedAttributes: JSON object, optional. See requestedAttributes below.

timestamp: long, mandatory. Describes the time when the confirmation by the end user was validated on Freja eID server side. Expressed in milliseconds, since January 1, 1970, 00:00 UTC.

{
   "basicUserInfo":{
      "name":"User's name",
      "surname":"User's surname"
   },
   "emailAddress":"User's primary email address",
   "allEmailAddresses":[
      {
         "emailAddress":"User's email address"
      },
      {
         "emailAddress":"User's email address"
      }
   ],
	"allPhoneNumbers":[
		{
			"phoneNumber":"User's phone number"
		},
		{
			"phoneNumber":"User's phone number"
		}
	  ],	
   "dateOfBirth":"User's date of birth",
   "age":"User's age", 
   "photo":"User's photo, Base64 encoded JPEG bytes",
   "addresses":[
      {
         "country":"Country",
         "city":"City",
         "postCode":"Postal code",
         "address1":"Street, number or equivalent",
         "address2":"Street, number or equivalent",
         "address3":"Street, number or equivalent",
         "validFrom":"Date from which the address is valid",
         "type":"Type of user's address",
         "sourceType":"Source from which the address is obtained"
      }
   ],
   "customIdentifier":"Custom identifier set by the Relying Party",
   "ssn":{
      "ssn":"Social security number of the end user",
      "country":"Country of SSN"
   },
   "document" : {
      "type":"Type of document used for registration e.g. passport",
      "country":"Document issuing country",
      "serialNumber":"Document serial number",
      "expirationDate":"Document expiration date"
   },
   "documentPhoto":"Document photo, Base64 encoded JPEG bytes",
   "registrationLevel":"User's registration level in Freja eID",
   "relyingPartyUserId":"Unique user ID reserved for Relying Parties",
   "integratorSpecificUserId":"Unique user ID reserved for Integrators"
}

basicUserInfo: JSON object which contains user's name and surname.

emailAddress: String, representing the user's primary email address.

allEmailAddresses: List of JSON objects which contains all end user's registered email addresses. The list will contain the primary email address and up to 2 other email addresses user might have connected to their account. Email addresses will be randomly sorted. If the user does not have any additional email addresses registered, the list will contain only the primary email address.

allPhoneNumbers:  List of JSON objects which contains all end user's registered phone numbers. This list will contain up to 3 phone numbers the user might have connected to their account. If no phone number is registered for a given user, an empty list will be returned.

dateOfBirth: String containing date of birth in format: YYYY-MM-DD.

age: Integer, calculated based on the date of birth.

photo: String, Base64 encoded JPEG bytes.

addresses: List of JSON objects which contains one or more end user's addresses. If no address is registered for a given user, an empty list will be returned. Each object will contain the following information:

country: String. Contains the ISO-3166 two-alphanumeric country code of the country where the user's address resides.
city: String. City in which the user's address resides.
postCode: String. Postal code of the city or city area in which the user's address resides. 
address 1, 2, 3: String. Up to three lines of address information containing, for example, street and number, house name or apartment number, and ‘care of’ or ‘attention’ designations, area or village clarifications. The number of lines in the response depends on the address information. At least one will be returned. 
validFrom: String. Date from which the address is valid, according to the source of information. Date is returned in format: YYYY-MM-DD (ISO-8601)
type: String. Type of address. Currently, can be RESIDENTIAL or POSTAL. 
sourceType: String. Type of source from which the information about the address has been obtained. Currently, only GOVERNMENT_REGISTRY can be returned. Namely, in the current version of Freja eID, the information about the end user's address is obtained from Statens personadressregister (SPAR) for Sweden and Det Sentrale Folkeregister (DSF) for Norway. 

ssn: JSON object which contains social security number and country.

document: List of JSON objects with information about the user's document used in registration. Each object will contain the following information:

• type: String. The type of document used during registration abbreviated and returned as: "PASS" (passport), "DRILIC" (driving licence), "NATID" (national ID card), "IDSIS" (SIS-issued ID document), "TAXID" (document issued by the Swedish Tax Authority), and "OTHERID" (any other type of document).
• country: String. Contains the ISO-3166 two-alphanumeric country code of the issuing country.
• serialNumber: String representing the document's serial number.
• expirationDate: String containing the document's expiration date in the format: YYYY-MM-DD.

documentPhoto: String, Base64 encoded JPEG bytes.

registrationLevel: the user's registration level in Freja eID, can be BASIC, EXTENDED or PLUS

relyingPartyUserId: String, mandatory. Represents a unique, user-specific value that allows the Relying Party to identify the same user across multiple sessions.

integratorSpecificUserId: String, represents a unique, user-specific value that allows Integrators to identify the same user across multiple sessions regardless of the Integrated Relying Party service that the user is using. For more info, see the section about Integrator Relying Party Management. 

customIdentifier: String, a unique, Relying Party-specific, user identifier, set by the Relying Party itself through the Custom Identifier Management.

{
   "includePrevious":"Include previously returned results"
}

includePrevious: string, mandatory. Must be equal to ALL. Indicates that the complete list of authentications successfully initiated by the relying party within the last 10 minutes will be returned, including results for previously completed authentication results that have been reported through an earlier call to one of the methods for getting authentication results. 

If you wish to fetch multiple authentication results, follow these steps:

1. Create the JSON structure {"includePrevious":"ALL"}
2. Encode the JSON structure to Base64.
3. Create the HTTP POST request with a POST parameter name getAuthResultsRequest and the Base64 encoded JSON structure from the step 2 as its value.

The HTTP body should be the following:

getAuthResultsRequest=eyJpbmNsdWRlUHJldmlvdXMiOiJBTEwifQ==

{
   "authenticationResults":[
      {
         "authRef":"Authentication reference",
         "status":"Authentication status",
         "relyingPartyUserId":"Unique user ID reserved for Relying Parties",
         "details":"JWS signed data, see below",
         "requestedAttributes":{
            "basicUserInfo":{
               "name":"Joe",
               "surname":"Black"
            },
            "emailAddress":"joe.black@freja.com",
            "allEmailAddresses":[
               {
                  "emailAddress":"joe.black@freja.com"
               },
               {
                  "emailAddress":"joebl@domain.com"
               }
            ],
            "allPhoneNumbers":[
                {
                    "phoneNumber":"+4600000000"
                },
                {
                    "phoneNumber":"+4611111111"
                }
            ], 
            "dateOfBirth":"1987-10-18",
            "age":"34",
            "photo":"SlBFRyBpbWFnZSBieXRlcyBnb2VzIGhlcmUgLi4u",  
             "addresses":[
               {
                  "country":"SE",
                  "city":"Stockholm",
                  "postCode":"11120",
                  "address1":"c/o Joe Black",
                  "address2":"Visdomsgatan 55",
                  "validFrom":"2020-03-19",
                  "type":"RESIDENTIAL",
                  "sourceType":"GOVERNMENT_REGISTRY"
               },
               {
                  "country":"NO",
                  "city":"Oslo",
                  "postCode":"0001",
                  "address1":"P.O. Box 456",
                  "validFrom":"2020-03-19",
                  "type":"POSTAL",
                  "sourceType":"GOVERNMENT_REGISTRY"
               }
            ],
            "ssn":{
               "ssn":"198710180040",
               "country":"SE"
            },
            "document" : {
               "type":"PASS",
               "country":"SE",
               "serialNumber":"XA0000001",
               "expirationDate":"2027-01-01"
            },
            "documentPhoto":"SlBFRyBpbWFnZSBieXRlcyBnb2VzIGhlcmUgLi4u",
            "registrationLevel":"PLUS",
            "relyingPartyUserId":"94039a98c8d",
            "integratorSpecificUserId":"54059a95c8d",
            "customIdentifier":"vejobla"             
      },
      {
         "authRef":"..."
      }
   ]
}

authenticationResults: an array of JSON objects, mandatory. An array of authentication result objects (if the authRef parameter was passed, the array will always be of length 1).

authRef: string, mandatory . The authentication reference of the authentication.

status: string, mandatory. One of: 

• STARTED (the transaction has been started but not yet delivered to Freja eID application associated with the end user),
• DELIVERED_TO_MOBILE (the Freja eID app has downloaded the transaction),
• CANCELED (the end user declined the authentication request),
• RP_CANCELED (the authentication request was sent to the user but canceled by the RP before the user could respond),
• EXPIRED (the authentication request was not approved by the end user within the authentication validity limit of two minutes),
• APPROVED (the authentication was successful) or
• REJECTED (e.g. if you try to run more than one authentication transaction for the same user at the same time).

details: JWS signed object (see details as described in the Get one authentication result method above), optional.

requestedAttributes: JSON object (see details as described in the Get one authentication result method above), optional.

If you wish to cancel an authentication request, follow these steps:

1. Create the JSON structure {"authRef":"GOHPyJcoKLJ+zKCEy4abi6jOO+q5VK+S1+UO5OXRmOPu42ixvVnsVgs7ADYUfG8m"}
2. Encode the JSON structure to Base64.
3. Create the HTTP POST request with a POST parameter name cancelAuth and the Base64 encoded JSON structure from the step 2 as its value.

The HTTP body should be the following (line broken for clarity only):

cancelAuthRequest=eyJhdXRoUmVmIjoiR09IUHlKY29LTEorektDRXk0YWJpNmpPTytxNVZLK1MxK1VP
NU9YUm1PUHU0Mml4dlZuc1ZnczdBRFlVZkc4bSJ9