Description

Returns alle the receivers registered to the provider

HTTP method: GET
URI: https://api.signere.no/api/Receiver?ProviderId={ProviderId}
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document on the portal"
Parameters
  • ProviderId: The Provider ID (Guid) (FromUri)
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"
    },
    {
        "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"?>
<ArrayOfReceiverResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <ReceiverResponse>
      <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>
   <ReceiverResponse>
      <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>
</ArrayOfReceiverResponse>
Response is list of:
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