Description

Creates a app launch uri for the BankID app (iOS and Android) for signing a document for given signeeref

HTTP method: PUT
URI: https://api.signere.no/api/externalsign/BankIDAppUrl
Autorization model: Primary apikey is needed for this operation.
Subscription needed: "Sign document online"
Parameters
Name Type Description Example value Required Max length Min length Nullable Enum Regex
DocumentId Guid The ID (GUID) of the Document. 1D4C883ED2CE48C8B4A9A08A00D4D3A4 True 36 36 False False ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
SigneeRefId Guid The ID (GUID) of the Signeeref. 1D4C883ED2CE48C8B4A9A08A00D4D3A4 True 36 36 False False ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
UserAgent String The useragent string of the device used to choose between iOS and Android. Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B511 Safari/9537.53 True 255   False False
Name DocumentId
Type Guid
Description The ID (GUID) of the Document.
Example value 1D4C883ED2CE48C8B4A9A08A00D4D3A4
Required True
Max length 36
Min length 36
Nullable False
Enum False
Regex ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
Name SigneeRefId
Type Guid
Description The ID (GUID) of the Signeeref.
Example value 1D4C883ED2CE48C8B4A9A08A00D4D3A4
Required True
Max length 36
Min length 36
Nullable False
Enum False
Regex ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
Name UserAgent
Type String
Description The useragent string of the device used to choose between iOS and Android.
Example value Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B511 Safari/9537.53
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex
{
    "SigneeRefId": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "DocumentId": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B511 Safari/9537.53 "
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateExternalSignAppRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <SigneeRefId>1d4c883e-d2ce-48c8-b4a9-a08a00d4d3a4</SigneeRefId>
   <DocumentId>1d4c883e-d2ce-48c8-b4a9-a08a00d4d3a4</DocumentId>
   <UserAgent>Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B511 Safari/9537.53 </UserAgent>
</CreateExternalSignAppRequest>