Description

Creates a receiver for this provider

HTTP method: POST
URI: https://api.signere.no/api/Receiver
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document on the portal"
Parameters
  • request: Contains all necessary parameters to create a receiver (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
Category String The category of the receiver. For instance this receiver is an employee Employee False   250 False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
CompanyName String The organization associated with the receiver, for instance if he/she represents a company Example Company False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Email String The e-mail address to the receiver kari@normann.no 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])?
ExternalId String The external ID of the receiver. For instance the customer number in the systems of the document provider 1234 False 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
FirstName String The receiver's first/given name Kari True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
LastName String The receiver's last name Normann True 255   False False ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Mobile String The mobile phone number to the receiver +4799775533 False 255   False False ^(\(?\+47\)?)?[- ]?([4|9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})$
OrgNo String The organization number associated with the receiver, for instance if he/she represents a company 987654321 False 9 9 False False ^([8|9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])$
SocSecHash String The receiver's social security number 01018574894 False 10 13 False False ^([0-9]{6})[ ]?([0-9]{5})$
Name Category
Type String
Description The category of the receiver. For instance this receiver is an employee
Example value Employee
Required False
Max length  
Min length 250
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name CompanyName
Type String
Description The organization associated with the receiver, for instance if he/she represents a company
Example value Example Company
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name Email
Type String
Description The e-mail address to the receiver
Example value kari@normann.no
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])?
Name ExternalId
Type String
Description The external ID of the receiver. For instance the customer number in the systems of the document provider
Example value 1234
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name FirstName
Type String
Description The receiver's first/given name
Example value Kari
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name LastName
Type String
Description The receiver's last name
Example value Normann
Required True
Max length 255
Min length  
Nullable False
Enum False
Regex ^[a-z A-Z\u0080-\u00FF 0-9 _ . = / + @ % & : \- , ; ! ? ( ) \r\\n \n \r { } \[ \] ]*$
Name Mobile
Type String
Description The mobile phone number to the receiver
Example value +4799775533
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex ^(\(?\+47\)?)?[- ]?([4|9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})[- ]?([0-9]{1})([0-9]{1})$
Name OrgNo
Type String
Description The organization number associated with the receiver, for instance if he/she represents a company
Example value 987654321
Required False
Max length 9
Min length 9
Nullable False
Enum False
Regex ^([8|9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])([0-9])$
Name SocSecHash
Type String
Description The receiver's social security number
Example value 01018574894
Required False
Max length 10
Min length 13
Nullable False
Enum False
Regex ^([0-9]{6})[ ]?([0-9]{5})$
{
    "FirstName": "Kari",
    "LastName": "Normann",
    "Mobile": "+4799775533",
    "Email": "kari@normann.no",
    "OrgNo": "987654321",
    "CompanyName": "Example Company",
    "ExternalId": "1234",
    "SocSecHash": "01018574894",
    "Category": "Employee"
}

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

<?xml version="1.0" encoding="utf-8"?>
<CreateReceiverRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <Category>Employee</Category>
   <CompanyName>Example Company</CompanyName>
   <Email>kari@normann.no</Email>
   <ExternalId>1234</ExternalId>
   <FirstName>Kari</FirstName>
   <LastName>Normann</LastName>
   <Mobile>+4799775533</Mobile>
   <OrgNo>987654321</OrgNo>
   <SocSecHash>01018574894</SocSecHash>
</CreateReceiverRequest>
Response example
{
    "Id": "1d4c883ed2ce48c8b4a9a08a00d4d3a4",
    "FirstName": "Kari",
    "LastName": "Normann",
    "Mobile": "+4799775533",
    "Email": "kari@normann.no",
    "OrgNo": "987654321",
    "CompanyName": "Example Company",
    "ExternalId": "1234",
    "SocSecHash": "01018574894",
    "Category": "Employee"
}
<?xml version="1.0" encoding="utf-8"?>
<ReceiverResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <Category>Employee</Category>
   <CompanyName>Example Company</CompanyName>
   <Email>kari@normann.no</Email>
   <ExternalId>1234</ExternalId>
   <FirstName>Kari</FirstName>
   <Id>1d4c883e-d2ce-48c8-b4a9-a08a00d4d3a4</Id>
   <LastName>Normann</LastName>
   <Mobile>+4799775533</Mobile>
   <OrgNo>987654321</OrgNo>
   <SocSecHash>01018574894</SocSecHash>
</ReceiverResponse>
Name Type Description Example value Nullable Enum
Category String The category of the receiver. For instance this receiver is an employee Employee False False
CompanyName String The organization associated with the receiver, for instance if he/she represents a company Example Company False False
Email String The e-mail address to the receiver kari@normann.no False False
ExternalId String The external ID of the receiver. For instance the customer number in the systems of the document provider 1234 False False
FirstName String The receiver's first/given name Kari False False
Id Guid The ID (GUID) of the receiver. 1D4C883ED2CE48C8B4A9A08A00D4D3A4 False False
LastName String The receiver's last name Normann False False
Mobile String The mobile phone number to the receiver +4799775533 False False
OrgNo String The organization number associated with the receiver, for instance if he/she represents a company 987654321 False False
SocSecHash String The receiver's social security number 01018574894 False False