Support Centre

/*
* When initiating authentication, you can request the minimum registration level of the user.
*/

String email = "[email protected]";
RegistrationState minRegistrationLevel = RegistrationState.PLUS;
InitiateAuthenticationRequest initiateAuthenticationRequest = 
    InitiateAuthenticationRequest
        .createCustom()
        .setEmail(email)
        .setMinRegistrationLevel(minRegistrationLevel)
        .build();
String transactionReference = authenticationClient
        .initiate(initiateAuthenticationRequest);

Requesting Additional User Information

You can also ask for additional information about the user. Currently, supported user attributes that can be requested are:

• BASIC_USER_INFO (name and surname), 
• EMAIL_ADDRESS (user's primary email address),
  

  If you would prefer an email with specific email domain please get in touch with [email protected].

• ALL_EMAIL_ADDRESSES (all user's email addresses registered in Freja eID),
• ALL_PHONE_NUMBERS (all user's phone numbers registered in Freja eID),
• DATE_OF_BIRTH (user's date of birth), 
• AGE (user's age),
• PHOTO (Base64 encoded PNG bytes of user's photo),
• ADDRESSES (user's current physical addresses),
• SSN (social security number/personal identity number and country),
• DOCUMENT (user's document type, serial number, country and expiry time)
• RELYING_PARTY_USER_ID (a unique, user-specific value that allows the Relying Party to identify the same user across multiple sessions),
• CUSTOM_IDENTIFIER (a unique, Relying Party-specific, user identifier, set by the Relying Party through the Custom Identifier Management Client)
• REGISTRATION_LEVEL (the user's registration level in Freja eID)
• COVID_CERTIFICATES (user's Covid-19 vaccination, test or recovery data)
  

  In order to be able to request this attribute, you must first get in touch with [email protected].

If you wish to ask for any of these user attributes, you need to pass another parameter in initAuthRequest builder - an array of attributes that represents that extra information required.

If you wish to ask for BASIC_USER_INFO, DATE_OF_BIRTH, SSN, DOCUMENT or ADDRESSES, you must set the minRegistrationLevel parameter in the initAuthRequest to EXTENDED or PLUS or the request will fail.

/*
* Additional information about the user to be returned. Interpreted as a 
* set of attributes that represents that extra information required.
* The requested information is returned when fetching authentication 
* results.
*/

String email = "[email protected]";
RegistrationState minRegistrationLevel = RegistrationState.EXTENDED;
AttributeToReturn[] attributes = {AttributeToReturn.BASIC_USER_INFO,
                                  AttributeToReturn.EMAIL_ADDRESS,
                                  AttributeToReturn.ALL_EMAIL_ADDRESSES,
                                  AttributeToReturn.ALL_PHONE_NUMBERS,
                                  AttributeToReturn.DATE_OF_BIRTH,
                                  AttributeToReturn.AGE,
                                  AttributeToReturn.PHOTO,
                                  AttributeToReturn.ADDRESSES,
                                  AttributeToReturn.SSN,
                                  AttributeToReturn.DOCUMENT,
                                  AttributeToReturn.RELYING_PARTY_USER_ID,
                                  AttributeToReturn.CUSTOM_IDENTIFIER,
                                  AttributeToReturn.REGISTRATION_LEVEL,
                                  AttributeToReturn.COVID_CERTIFICATES
                                  };
InitiateAuthenticationRequest initiateAuthenticationRequest =
    InitiateAuthenticationRequest
        .createCustom()
        .setEmail(email)
        .setMinRegistrationLevel(minRegistrationLevel)
        .setAttributesToReturn(attributes)
        .build();
String transactionReference = authenticationClient
        .initiate(initiateAuthenticationRequest);

For each Integrated Relying Party, as well as for the Integrator Relying Party itself, Freja eID generates a unique identifier called relyingPartyId. The Integrator Relying Party needs to pass this identifier in each request. Read more about Integrator Relying Parties here.

/*
* Parameter relyingPartyId represents a unique ID of the Relying Party
* for which the authentication request should be initiated.
*/

String relyingPartyId = "relying_party_id";
 
InitiateAuthenticationRequest initiateAuthenticationRequest =
    InitiateAuthenticationRequest
        .createCustom()
        .setEmail(email)
        .setRelyingPartyId(relyingPartyId)
        .build();

/*
* Parameter relyingPartyId represents a unique ID of the Relying Party
* for which the authentication request should be initiated.
*/

String relyingPartyId = "relying_party_id";
 
/*
* When initiating authentication, you have to set relyingPartyId for
* every request. See the example below.
*/

String email = "[email protected]";
 
AttributeToReturn[] attributes =
    {AttributeToReturn.INTEGRATOR_SPECIFIC_USER_ID};
InitiateAuthenticationRequest initiateAuthenticationRequest =
    InitiateAuthenticationRequest
        .createCustom()
        .setEmail(email)
        .setAttributesToReturn(attributes)
        .setRelyingPartyId(relyingPartyId)
        .build();
String transactionReference = authenticationClient
        .initiate(initiateAuthenticationRequest);

/*
* A reference unique to the transaction that can be used to
* query the result of a transaction.
*/

String authRef ="reference";
  
/*
* In case of getResult method, response type is AuthenticationResult.
* Response contains authentication reference passed during 
* authentication initiation, status of the action, details 
* (can be used for extra validation of response)
* and, if requested during authentication initiation and the action has 
* been approved, the response potentially contains additional 
* attributes: basicUserInfo, emailAddress, allEmailAddresses, 
* dateOfBirth, age, photo, relyingPartyUserId, customIdentifier, ssn, 
* integratorSpecificUserId, allPhoneNumbers, addresses, documentInfo,
* registrationLevel and/or covidCertificates. 
* The request contains an authentication transaction 
* reference. See the example below.
*/

AuthenticationResultRequest authenticationResultRequest = 
    AuthenticationResultRequest
        .create(authRef);
AuthenticationResult response = authenticationClient
        .getResult(authenticationResultRequest);
String receivedAuthRef = response.getAuthRef();
ActionStatus status = response.getStatus();
String details = response.getDetails();
RequestedAttributes requestedAttributes = response
        .getRequestedAttributes();
BasicUserInfo basicUserInfo = requestedAttributes
        .getBasicUserInfo();
String emailAddress = requestedAttributes.getEmailAddress();
SsnUserInfo ssn = requestedAttributes.getSsn();
String relyingPartyUserId = requestedAttributes
        .getRelyingPartyUserId();
String dateOfBirth = requestedAttributes.getDateOfBirth();
Integer age = requestedAttributes.getAge();
String photo = requestedAttributes.getPhoto();
String customIdentifier = requestedAttributes
        .getCustomIdentifier();
String integratorSpecificUserId = requestedAttributes
        .getIntegratorSpecificUserId();
List<AddressInfo> addresses = requestedAttributes.getAddresses();
List<Email> allEmailAddresses = requestedAttributes
        .getAllEmailAddresses();
List<PhoneNumberInfo> allPhoneNumbers = requestedAttributes.getAllPhoneNumbers();
RegistrationLevel registrationLevel =
requestedAttributes.getRegistrationLevel();
DocumentInfo document =
requestedAttributes.getDocument();
CovidCertificates covidCertificates = requestedAttributes.getCovidCertificates();
String vaccinationCertificateBase45 = covidCertificates.getVaccines().getCertificate();
String testsCertificateBase45 = covidCertificates.getTests().getCertificate();
String recoveryCertificateBase45 = covidCertificates.getRecovery().getCertificate();

You can ask for integratorSpecificUserId attribute only if you are an Integrator Relying Party, and you need to pass relyingPartyId in the request.

Get Final Authentication Result

This is a blocking method and is used to fetch a single result with the final status (can be one of: rejected, approved, cancelled or expired) for a specified authentication reference. The method keeps polling until it receives the final status of the authentication action. If the maximum polling time expires before the action is completed, the method will throw an exception.

/*
* A reference unique to the transaction that can be used to
* query the result of that transaction.
*/

String authRef ="reference";

/*
* A maximum time in seconds to wait for a final status of action
* (to be approved, cancelled, rejected or expired).
*/

int maxWaitingTimeInSec = 120;

/*
* In case of pollForResult method, response type is AuthenticationResult.
* Response contains authentication reference passed during 
* authentication initiation, status of the action, details (can be used for 
* extra validation of response) and, if requested during authentication 
* initiation and the action has been approved, the response contains
* basicUserInfo, emailAddress, allEmailAddresses, dateOfBirth, age,
* photo, relyingPartyUserId, customIdentifier, ssn, 
* integratorSpecificUserId, documentInfo,
* allPhoneNumbers, addresses, registrationLevel and/or 
* covidCertificates.
* If maxWaitingTimeInSec passes and authentication action is not 
* completed with one of the final statuses, this method will throw
* FrejaEidClientPollingException.
*/

AuthenticationResultRequest authenticationResultRequest = 
    AuthenticationResultRequest
        .create(authRef);
AuthenticationResult response = authenticationClient
        .pollForResult(authenticationResultRequest, maxWaitingTimeInSec);
String receivedAuthRef = response.getAuthRef();
ActionStatus status = response.getStatus();
String details = response.getDetails();
RequestedAttributes requestedAttributes = response 
        .getRequestedAttributes();
BasicUserInfo basicUserInfo = requestedAttributes.getBasicUserInfo();
String emailAddress = requestedAttributes.getEmailAddress();
SsnUserInfo ssn = requestedAttributes.getSsn();
String relyingPartyUserId = requestedAttributes.getRelyingPartyUserId();
String dateOfBirth = requestedAttributes.getDateOfBirth();
Integer age = requestedAttributes.getAge();
String photo = requestedAttributes.getPhoto();
String customIdentifier = requestedAttributes.getCustomIdentifier();
String integratorSpecificUserId = requestedAttributes
        .getIntegratorSpecificUserId();
List<AddressInfo> addresses = requestedAttributes.getAddresses();
List<Email> allEmailAddresses = requestedAttributes
        .getAllEmailAddresses();
List<PhoneNumberInfo> allPhoneNumbers = requestedAttributes.getAllPhoneNumbers();
RegistrationLevel registrationLevel =
requestedAttributes.getRegistrationLevel();
DocumentInfo document = 
requestedAttributes.getDocument();
CovidCertificates covidCertificates = requestedAttributes.getCovidCertificates();
String vaccinationCertificateBase45 = covidCertificates.getVaccines().getCertificate();
String testsCertificateBase45 = covidCertificates.getTests().getCertificate();
String recoveryCertificateBase45 = covidCertificates.getRecovery().getCertificate();

You can ask for integratorSpecificUserId attribute only if you are an Integrator Relying Party, and you need to pass relyingPartyId in the request.

Get Authentication Results

This method is used to fetch the results of multiple outstanding authentications.

Integrator Relying Parties must pass relyingPartyId as part of the request.

/*
* Response type is list of authentication result.
* The response will contain a complete list of authentications,
* successfully initiated within the last 10 minutes.
*/

AuthenticationResultsRequest authenticationResultsRequest =
    AuthenticationResultsRequest.create();
List<AuthenticationResult> response = authenticationClient
        .getResults(authenticationResultsRequest);

Integrator Relying Parties must pass relyingPartyId as part of the request.

/*
* A reference unique to the transaction that can be used to cancel
* transaction.
*/

String authRef ="reference";
CancelAuthenticationRequest cancelRequest = 
    CancelAuthenticationRequest.create(authRef);
authenticationClient.cancel(cancelRequest);