W2 Data Ekyc Scandi 025

W2 Data Ekyc Scandi 025 Service

Content

 

This service can be used for identity checks in Sweden, Norway and Denmark. It uses Bank ID to confirm an individual's identity.

This service works slightly differently from our other services in that it runs asynchronously and has a two step process. First you will need to send us the identity to check. We will process this information and return a URL for Bank ID verification. The user will need to navigate to this URL in a browser and complete the Bank ID process there. Once this form is completed the user will be redirected to a URL of your choice.

When the Bank ID form is complete W2 will send a notification with the results of the identity check. We can either notify by email or send an HTTP POST to an endpoint of your choice.

You can force the service to skip the Bank ID process by specifying the SkipScandiBankId QueryOption. This will return the result immediately but the response will only contain information from our supplier's database and not a full Bank ID check and as such should not be considered a full two plus two check.

Before using this service you will need to let W2 know the following:

      1. Notification Preference: Whether you would prefer to be notified by email, HTTP POST or both.
      2. Email Address: If you want to be notified by email then we need to know which email address to use.
      3. Notification URL: If you want to be notified by HTTP POST then we need to know a URL to use. see here for more information.
      4. FormattingType: By default if we send an HTTP POST it will be JSON, we can also do XML if prefered.

For this service we require the following information. Please note that:

  1. Most of the required data is supplied in the <QueryData> object as usual, but we also require a redirect URL be supplied in the <QueryOptions> see below.
  2. In an actual SOAP request the data should be supplied in alphabetical order.

Query Data

Property Name Type Length Optional/Mandatory Notes
Forename
String
15 Mandatory  
Surname
String
15 Mandatory  
City
String
30 Mandatory  
Country
String
3 Mandatory This must be a 3 character ISO Country code. This service only accepts SWE, DNK or NOR. i.e. Sweden, Denmark or Norway
HouseNameNumber
String
30 Mandatory if no HouseName or HouseNumber given  
HouseName
String
30 Mandatory if no HouseNameNumber or HouseNumber given  
HouseNumber
String
30 Mandatory if no HouseNameNumber or HouseName given  
Street
String
30 Mandatory  
Region
String
30 Optional  
Post Code
String
10 Mandatory  
Day of Birth
Integer
2 Mandatory  
Month of Birth
Integer
2 Mandatory  
Year of Birth
Integer
4 Mandatory  
NationalId
String
 15 Optional  
DateOfBirthMatchThreshold
Integer
2 Optional This can be used to specify the percentage match for date of birth matches. For example if you put 90 in this field then we will consider a 90% match on date of birth to be a pass, when we calculate the interpret result.
NameQueryMatchThreshold
Integer
2 Optional This can be used to specify the percentage match for name matches. For example if you put 90 in this field then we will consider a 90% match on name to be a pass, when we calculate the interpret result.

Query Options 

Property Name Optional/Mandatory Notes
RedirectUrl Mandatory This is the URL the user will be redirected to after they have filled in the Bank ID form.
     
SkipScandiBankId Optional If this is set to "true" then the service will not supply a url for a Bank ID form. It will simply send whatever information is available as per your notification settings.
AddressMatchThreshold Optional 0-100, specifies the required level of matching in the address.

Example Request

An example request might look like this

    <QueryData>
        <City>BILLDAL</City>
        <Country>SWE</Country>
        <DayOfBirth>04</DayOfBirth>
        <Forename>SIRI</Forename>
        <MonthOfBirth>06</MonthOfBirth>
        <NationalId>23434645634</NationalId>
        <Postcode>21725</Postcode>
        <Region></Region>
        <Street>ERIKSBO VÄSTERGÄRDE 47</Street>
        <Surname>Petersen</Surname>
        <YearOfBirth>1952</YearOfBirth>
    </QueryData>
    <QueryOptions>
        <KeyValueOfstringstring>
            <Key>RedirectUrl</Key>
            <Value>https://{MY_WEBSITE}</Value>
        </KeyValueOfstringstring>
    </QueryOptions>

The response for this service simply contains a URL for the Bank ID form and a message. For example:

    <W2DataEkycScandi025Result>
<Message>Please complete the form at the supplied URL</Message> <BankIdFormUrl> https://test.zignsec.com/v2/Hosted/{some guid here} </BankIdFormUrl> </W2DataEkycScandi025Result>

The response from a request where the bank id check is skipped contains a two plus two result. For example:

 <W2DataEkycScandi025Result >
<BankIdFormUrl/>
<InterpretResult>Pass<InterpretResult>
<Message>Name and Address match found.<Message>
<TwoPlusTwoCheckResult >
<IndependentDataSources/>
<MatchResult>OnePlusOne<MatchResult>
<NameAndAddressMatch>true<NameAndAddressMatch>
<NameAndDateOfBirthMatch>false<NameAndDateOfBirthMatch>
<TwoPlusTwoCheckResult>
<W2DataEkycScandi025Result>

The transaction information will simply indicate the transaction was successful as no actual interpretation has been performed.

    <ServiceTransactionInformation>
        <FailedOverTo i:nil="true"/>
        <HaltTriggered>false</HaltTriggered>
        <Service>W2_DATA_EKYC_SCANDI_025</Service>
        <ServiceInterpretResult>NotPerformed</ServiceInterpretResult>
        <ServiceTransactionResult>Success</ServiceTransactionResult>
        <ServiceTransactionResultMessage i:nil="true"/>
        <ServiceValidationDetails i:nil="true"/>
        <ValidationResult>Pass</ValidationResult>
    </ServiceTransactionInformation>
    

Once the query has finished, you should be returned a generated URL within the <BankIdFormUrl> tags, you can use this to navigate to the page, and on this page there is a Bank ID login page. Once the user has successfully logged into their Bank ID (and by doing so, authorised you to use their data), the page will redirect to the URL you have previously specified. The system will then return a notification to you in the form of an e-mail, or a POST to an endpoint.

When the Bank ID form has been completed W2 will attempt to notify you. We can either send an email or POST to an endpoint.

The email will look something like this:

email

 

The post will be JSON and contains information from the verification process. We can also supply in XML if required, contact W2 support to configure this. The following is an example JSON response:

  • POST
  • Authorization: "Basic {CompanyName}:{ApiKey}" (Encoded as Base 64 string)
  • Content-Type: "application/json"
  • Content-Length: { The byte length of the content }
{  
   "EventType":"ApiV3ServiceResponse",
   "ClientReference":"The client reference from the original call",
   "CallReference":"The call reference from the original call",
   "ClientSubaccount":"The client subaccount from the original call",
   "ServiceResults":{
      "W2DataEkycScandi025":{
         "InterpretResult":"PASS | FAIL | REFER | ERROR",
         "CallId":"A unique identifier for the call",
         "TwoPlusTwoResult":{
            "MatchResult":"TwoPlusTwo | TwoPlusOne | OnePlusOne",
            "NameAndAddressMatch": true | false,
            "NameAndDateOfBirthMatch":true | false,
            "IndependentDataSources":true | false | null
         },
         "Message":"The status of the response",
         "NameAndAddressMessage":"The status of the name and address match in the two plus two check",
         "NameAndDateOfBirthMessage":"The status of the name and date of birth match in the two plus two check"
      }
   },
   "TransactionInformation":{
      "ServiceTransactions":[
         {
            "Service":"W2_DATA_EKYC_SCANDI_025",
            "ServiceInterpretResult":"PASS | FAIL | REFER | ERROR",
            "ServiceTransactionResult":"Success | Fail"
         }
      ]
   }
}