Description

Starts a BankID mobile sign session for the given document, with given mobilenumber and date of birth. Returns the BankID mobile reference "Snill bank"

HTTP method: PUT
URI: https://api.signere.no/api/externalsign/BankIDMobileSign
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
DateOfBirth String The date of birth to use in BankID mobile signing. 071283 True 6   False False ^[0-9]{6}$
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})$
Mobile String The mobilenumber to use in BankID mobile signing. +4799716935 True 255   False False ^([4|9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])$
ReceiptSMS Boolean Send SMS receipt to signere after Document is Signered. true False 5 4 False False ^((t|T)(r|R)(u|U)(e|E))$|^((f|F)(a|A)(l|L)(s|S)(e|E))$
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})$
Name DateOfBirth
Type String
Description The date of birth to use in BankID mobile signing.
Example value 071283
Required True
Max length 6
Min length  
Nullable False
Enum False
Regex ^[0-9]{6}$
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 Mobile
Type String
Description The mobilenumber to use in BankID mobile signing.
Example value +4799716935
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ^([4|9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])$
Name ReceiptSMS
Type Boolean
Description Send SMS receipt to signere after Document is Signered.
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 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})$
{
    "SigneeRefId": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "DocumentId": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "Mobile": "+4799716935",
    "DateOfBirth": "071283",
    "ReceiptSMS": true
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateExternalSignBankIDMobileSignRequest 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>
   <Mobile>+4799716935</Mobile>
   <DateOfBirth>071283</DateOfBirth>
   <ReceiptSMS>true</ReceiptSMS>
</CreateExternalSignBankIDMobileSignRequest>