Description

This API endpoint is deprecated read description below for more information!

DEPRECATED goto https://id.signere.no for our new authentication api Creates a SignereID request, and returns a url. This url can be used in an iFrame (if the iFrame property is set) or used in a redirect. Example url: https://idtest.signere.no/NoBankIDWeb/Detector?sessionid=251952826...... To detect if user is on a mobile device check out http://detectmobilebrowsers.com/. To check for tablet add check for ipad/android or mobile in the useragent string. The login will automaticly get status LOGINTIMEDOUT 5 minutes after successfull login Use this javascript if you use WebMessaging https://signerecommon.blob.core.windows.net/files/signereid_webmessaging.js

HTTP method: POST
URI: https://api.signere.no/api/SignereId
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "SignereID"
Parameters
Name Type Description Example value Required Max length Min length Nullable Enum Regex
List of AddonService List of addon data that can be orderd. The result will be in MetaData list of the reponse (For future use, not implemented yet!) no.officaladdress False     False False
CancelUrl String URL that the user will be redirected to if the auth process is aborted by the user. [1] is a placeholder for the request ID and [2] is placeholder for your ownid (ExternalReference). https://wwww.yourdomain.no/auth/abort.aspx?requestid=[1]&externalid=[2] True 800   False False ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
DateOfBirth String Date of birth to use in BankID mobile login. When this and mobilenumber is set the BankID mobile is started without the web GUI. Use this if you want to make your own GUI (For future use, not implemented yet!) 071283 False 255   False False ^[0-9]{6}$
Domain String The domain the site is running on, used in combination with iFrame and content security policy www.domain.com False 255   False False ((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])|(localhost:\d{0,5}))$
ErrorUrl String URL that the user will be redirected to if the signing process is successful. [0] is a placeholder the status (Se response for types) (RequestID and ExternalReference can also we replaced). https://wwww.yourdomain.no/signsuccess.aspx?status=[0] True 800   False False ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
ExternalReference String ExternalReference could be externalsite sessionid 1D4C883ED2CE48C8B4A9A08A00D4D3A4 True 255   False False Cannot contain script tag of any type
GetSocialSecurityNumber Boolean Should the socialsecuritynumber be fetched from BankID? Beware that there is an extra cost of doing this every time. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Height Int32 Height of the BankID frame when used in iFrame. 400 False     True False ^\d+$
IdentityProviderType Set this to the type of Identityprovider that you want to use. (You have to have an subscription to the providers that you use, if not contact sales@signere.no NO_BANKID_WEB True 17 7 False True ^[a-zA-Z0-9_]*$
Languages Language of the login EN False 2 2 False True ^[a-zA-Z0-9_]*$
Mobile String Mobilenubmer to use in BankID mobile login. When this and dateofbirth is set the BankID mobile is started without the web GUI. Use this if you want to make your own GUI (For future use, not implemented yet!) 918121234 False 255   False False ^[+]?([0-9 ()\-/]{8,18})$
PageTitle String Title of the login page (Used when redirecting on larger devices) Login to my fine page. False 255   False False Cannot contain script tag of any type
SocialSecurityNumber String If this is specified then the client will be prefilled with this value. (supported by Norwegian BankID) 23071212345 False 10 13 False False
SuccessUrl String URL that the user will be redirected to if the auth process is successful. [1] is a placeholder for the request ID, and [2] is placeholder for your ownid (ExternalReference). https://wwww.yourdomain.no/auth/success.aspx?requestid=[1]&externalid=[2] True 800   False False ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
UseIframe Boolean Should the login page be used in an iframe, the content will then be only the client and, the redirect is done in javascript. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
UseWebMessaging Boolean Use HTML5 Web messaging to redirect iFrame, use this on newer device that have problem redirect because of not same origin policy in the browser. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name AddonServices
Type List of AddonService
Description List of addon data that can be orderd. The result will be in MetaData list of the reponse (For future use, not implemented yet!)
Example value no.officaladdress
Required False
Max length  
Min length  
Nullable False
Enum False
Regex
Name CancelUrl
Type String
Description URL that the user will be redirected to if the auth process is aborted by the user. [1] is a placeholder for the request ID and [2] is placeholder for your ownid (ExternalReference).
Example value https://wwww.yourdomain.no/auth/abort.aspx?requestid=[1]&externalid=[2]
Required True
Max length 800
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
Name DateOfBirth
Type String
Description Date of birth to use in BankID mobile login. When this and mobilenumber is set the BankID mobile is started without the web GUI. Use this if you want to make your own GUI (For future use, not implemented yet!)
Example value 071283
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[0-9]{6}$
Name Domain
Type String
Description The domain the site is running on, used in combination with iFrame and content security policy
Example value www.domain.com
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])|(localhost:\d{0,5}))$
Name ErrorUrl
Type String
Description URL that the user will be redirected to if the signing process is successful. [0] is a placeholder the status (Se response for types) (RequestID and ExternalReference can also we replaced).
Example value https://wwww.yourdomain.no/signsuccess.aspx?status=[0]
Required True
Max length 800
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
Name ExternalReference
Type String
Description ExternalReference could be externalsite sessionid
Example value 1D4C883ED2CE48C8B4A9A08A00D4D3A4
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name GetSocialSecurityNumber
Type Boolean
Description Should the socialsecuritynumber be fetched from BankID? Beware that there is an extra cost of doing this every time.
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name Height
Type Int32
Description Height of the BankID frame when used in iFrame.
Example value 400
Required False
Max length  
Min length  
Nullable True
Enum False
Regex ^\d+$
Name IdentityProvider
Type IdentityProviderType
Description Set this to the type of Identityprovider that you want to use. (You have to have an subscription to the providers that you use, if not contact sales@signere.no
Example value NO_BANKID_WEB
Required True
Max length 17
Min length 7
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
Name Language
Type Languages
Description Language of the login
Example value EN
Required False
Max length 2
Min length 2
Nullable False
Enum True
Regex ^[a-zA-Z0-9_]*$
Name Mobile
Type String
Description Mobilenubmer to use in BankID mobile login. When this and dateofbirth is set the BankID mobile is started without the web GUI. Use this if you want to make your own GUI (For future use, not implemented yet!)
Example value 918121234
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[+]?([0-9 ()\-/]{8,18})$
Name PageTitle
Type String
Description Title of the login page (Used when redirecting on larger devices)
Example value Login to my fine page.
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex Cannot contain script tag of any type
Name SocialSecurityNumber
Type String
Description If this is specified then the client will be prefilled with this value. (supported by Norwegian BankID)
Example value 23071212345
Required False
Max length 10
Min length 13
Nullable False
Enum False
Regex
Name SuccessUrl
Type String
Description URL that the user will be redirected to if the auth process is successful. [1] is a placeholder for the request ID, and [2] is placeholder for your ownid (ExternalReference).
Example value https://wwww.yourdomain.no/auth/success.aspx?requestid=[1]&externalid=[2]
Required True
Max length 800
Min length  
Nullable False
Enum False
Regex ([a-zA-Z0-9]{2,10}\://[a-zA-Z0-9]{2,10}.*[a-zA-Z0-9\-\.\[\]?]*|[a-zA-Z0-9\-\.]*([?][a-zA-Z0-9]*[=][a-zA-Z0-9\-\.]*)|((([A-Za-z]{3,9}:(?:\/\/)?)(?:[-;:&=\+\$,\w]+@)?[A-Za-z0-9.-]+|(?:www.|[-;:&=\+\$,\w]+@)[A-Za-z0-9.-]+)((?:\/[\+~%\/.\w-_]*)?\??(?:[-\+=&;%@.\w_]*)#?(?:[.\!\/\\w]*))?)|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}/(?:[-;:&=\+\$,\w%~:]+@)?[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+|(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}|[a-zA-Z0-9.]{2,}://[a-zA-Z0-9\-\.]*[A-Z%~:/?!$&'()*+,#a-z0-9\[\]\;\@\=_.-]+)
Name UseIframe
Type Boolean
Description Should the login page be used in an iframe, the content will then be only the client and, the redirect is done in javascript.
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
Name UseWebMessaging
Type Boolean
Description Use HTML5 Web messaging to redirect iFrame, use this on newer device that have problem redirect because of not same origin policy in the browser.
Example value true
Required False
Max length 5
Min length 4
Nullable False
Enum False
Regex ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
{
    "Domain": "www.domain.com",
    "ErrorUrl": "https://wwww.yourdomain.no/signsuccess.aspx?status=[0]",
    "CancelUrl": "https://wwww.yourdomain.no/auth/abort.aspx?requestid=[1]&externalid=[2]",
    "SuccessUrl": "https://wwww.yourdomain.no/auth/success.aspx?requestid=[1]&externalid=[2]",
    "Language": "EN",
    "GetSocialSecurityNumber": true,
    "IdentityProvider": "NO_BANKID_WEB",
    "Mobile": "918121234",
    "DateOfBirth": "071283",
    "UseIframe": true,
    "UseWebMessaging": true,
    "SocialSecurityNumber": "23071212345",
    "Height": 400,
    "PageTitle": "Login to my fine page.",
    "ExternalReference": "1D4C883ED2CE48C8B4A9A08A00D4D3A4",
    "AddonServices": [
        {
            "Name": "no.national.registry",
            "Arguments": "{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}"
        },
        {
            "Name": "no.national.registry",
            "Arguments": "{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}"
        }
    ]
}

XML elements must be in same order as in this example xml

<?xml version="1.0" encoding="utf-8"?>
<SignereIdRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities.SignereID">
   <Domain>www.domain.com</Domain>
   <ErrorUrl>https://wwww.yourdomain.no/signsuccess.aspx?status=[0]</ErrorUrl>
   <CancelUrl>https://wwww.yourdomain.no/auth/abort.aspx?requestid=[1]&externalid=[2]</CancelUrl>
   <SuccessUrl>https://wwww.yourdomain.no/auth/success.aspx?requestid=[1]&externalid=[2]</SuccessUrl>
   <Language>EN</Language>
   <GetSocialSecurityNumber>true</GetSocialSecurityNumber>
   <IdentityProvider>NO_BANKID_WEB</IdentityProvider>
   <Mobile>918121234</Mobile>
   <DateOfBirth>071283</DateOfBirth>
   <UseIframe>true</UseIframe>
   <UseWebMessaging>true</UseWebMessaging>
   <SocialSecurityNumber>23071212345</SocialSecurityNumber>
   <Height>400</Height>
   <PageTitle>Login to my fine page.</PageTitle>
   <ExternalReference>1D4C883ED2CE48C8B4A9A08A00D4D3A4</ExternalReference>
   <AddonServices xmlns:d2p1="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
      <d2p1:AddonService>
         <d2p1:Arguments>{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}</d2p1:Arguments>
         <d2p1:Name>no.national.registry</d2p1:Name>
      </d2p1:AddonService>
      <d2p1:AddonService>
         <d2p1:Arguments>{username: 'yourusername',password: '*****', production: false,queryMode: 'NameDateOfBirth', reason: 'test', system: 'test'}</d2p1:Arguments>
         <d2p1:Name>no.national.registry</d2p1:Name>
      </d2p1:AddonService>
   </AddonServices>
</SignereIdRequest>
Response example
{
    "Url": "https://id.signere.no/NoBankIDMobile/Start?sessionid=3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2&providerId=c4ab63ae-81b6-49d2-b75c-a17301071188&iframe=False&webmessaging=False&language=NO&errorUrl=aHR0cHM6Ly9pZHRlc3Quc2lnbmVyZS5uby90ZXN0L2Vycm9yP3N0YXR1cz1bMF0%3D&",
    "RequestId": "3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2",
    "BankIDMobileReference": "Snill Bank",
    "Status": "UNKNOWN"
}
<?xml version="1.0" encoding="utf-8"?>
<CreateSignereIdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities.SignereID">
   <BankIDMobileReference>Snill Bank</BankIDMobileReference>
   <RequestId>3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2</RequestId>
   <Status>UNKNOWN</Status>
   <Url>https://id.signere.no/NoBankIDMobile/Start?sessionid=3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2&providerId=c4ab63ae-81b6-49d2-b75c-a17301071188&iframe=False&webmessaging=False&language=NO&errorUrl=aHR0cHM6Ly9pZHRlc3Quc2lnbmVyZS5uby90ZXN0L2Vycm9yP3N0YXR1cz1bMF0%3D&</Url>
</CreateSignereIdResponse>
Name Type Description Example value Nullable Enum
BankIDMobileReference String Only returned for Norwegian BankID and with date of birth and mobilenumber provided on the request (For future use, not implemented yet!) Snill Bank False False
RequestId String Signere requestid used to get the reponse form server afterwards 3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2 False False
Status The status of the BankID mobile (For future use, not implemented yet!) NO_BANKID_MOBILE_STARTED False True
Url String The url to use as src for iframe or to redirect the user to https://id.signere.no/NoBankIDMobile/Start?sessionid=3HtyxmFpQ5zXQ5o7aBvTYpbq630jvpNlZe1TNwzSi81v2&providerId=c4ab63ae-81b6-49d2-b75c-a17301071188&iframe=False&webmessaging=False&language=NO&errorUrl=aHR0cHM6Ly9pZHRlc3Quc2lnbmVyZS5uby90ZXN0L2Vycm9yP3N0YXR1cz1bMF0%3D& False False