WebService1


Click here for a complete list of operations.

SignDocument

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /signing.asmx HTTP/1.1
Host: signing.brixxs.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://signing.brixxs.com/SignDocument"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SignDocument xmlns="https://signing.brixxs.com/">
      <API_KEY>string</API_KEY>
      <tenantId>string</tenantId>
      <IBkey>string</IBkey>
      <host>string</host>
      <documentInfo>
        <name>string</name>
        <description>string</description>
      </documentInfo>
      <signatories>
        <signatory>
          <uuid>string</uuid>
          <name>string</name>
          <email>string</email>
          <role>SIGN or CC</role>
          <locale>en_US or nl_NL</locale>
          <localeSpecified>boolean</localeSpecified>
          <priority>DEFAULT or HIGH</priority>
          <prioritySpecified>boolean</prioritySpecified>
          <returnUrl>string</returnUrl>
          <authenticationMethod>
            <smsTan xsi:nil="true" />
            <mouse>boolean</mouse>
          </authenticationMethod>
        </signatory>
        <signatory>
          <uuid>string</uuid>
          <name>string</name>
          <email>string</email>
          <role>SIGN or CC</role>
          <locale>en_US or nl_NL</locale>
          <localeSpecified>boolean</localeSpecified>
          <priority>DEFAULT or HIGH</priority>
          <prioritySpecified>boolean</prioritySpecified>
          <returnUrl>string</returnUrl>
          <authenticationMethod>
            <smsTan xsi:nil="true" />
            <mouse>boolean</mouse>
          </authenticationMethod>
        </signatory>
      </signatories>
      <documentTemplate>
        <DocumentTemplateUUID>string</DocumentTemplateUUID>
      </documentTemplate>
      <useTimeStamp>boolean</useTimeStamp>
      <enableLTV>boolean</enableLTV>
      <separateAuditlog>boolean</separateAuditlog>
      <disableEmail>boolean</disableEmail>
      <content>base64Binary</content>
    </SignDocument>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <SignDocumentResponse xmlns="https://signing.brixxs.com/">
      <documentUUID>string</documentUUID>
      <SignatoryLink>
        <signatoryLink>
          <sequence>string</sequence>
          <email>string</email>
          <documentLink>string</documentLink>
          <role>SIGN or CC</role>
        </signatoryLink>
        <signatoryLink>
          <sequence>string</sequence>
          <email>string</email>
          <documentLink>string</documentLink>
          <role>SIGN or CC</role>
        </signatoryLink>
      </SignatoryLink>
    </SignDocumentResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /signing.asmx HTTP/1.1
Host: signing.brixxs.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SignDocument xmlns="https://signing.brixxs.com/">
      <API_KEY>string</API_KEY>
      <tenantId>string</tenantId>
      <IBkey>string</IBkey>
      <host>string</host>
      <documentInfo>
        <name>string</name>
        <description>string</description>
      </documentInfo>
      <signatories>
        <signatory>
          <uuid>string</uuid>
          <name>string</name>
          <email>string</email>
          <role>SIGN or CC</role>
          <locale>en_US or nl_NL</locale>
          <localeSpecified>boolean</localeSpecified>
          <priority>DEFAULT or HIGH</priority>
          <prioritySpecified>boolean</prioritySpecified>
          <returnUrl>string</returnUrl>
          <authenticationMethod>
            <smsTan xsi:nil="true" />
            <mouse>boolean</mouse>
          </authenticationMethod>
        </signatory>
        <signatory>
          <uuid>string</uuid>
          <name>string</name>
          <email>string</email>
          <role>SIGN or CC</role>
          <locale>en_US or nl_NL</locale>
          <localeSpecified>boolean</localeSpecified>
          <priority>DEFAULT or HIGH</priority>
          <prioritySpecified>boolean</prioritySpecified>
          <returnUrl>string</returnUrl>
          <authenticationMethod>
            <smsTan xsi:nil="true" />
            <mouse>boolean</mouse>
          </authenticationMethod>
        </signatory>
      </signatories>
      <documentTemplate>
        <DocumentTemplateUUID>string</DocumentTemplateUUID>
      </documentTemplate>
      <useTimeStamp>boolean</useTimeStamp>
      <enableLTV>boolean</enableLTV>
      <separateAuditlog>boolean</separateAuditlog>
      <disableEmail>boolean</disableEmail>
      <content>base64Binary</content>
    </SignDocument>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <SignDocumentResponse xmlns="https://signing.brixxs.com/">
      <documentUUID>string</documentUUID>
      <SignatoryLink>
        <signatoryLink>
          <sequence>string</sequence>
          <email>string</email>
          <documentLink>string</documentLink>
          <role>SIGN or CC</role>
        </signatoryLink>
        <signatoryLink>
          <sequence>string</sequence>
          <email>string</email>
          <documentLink>string</documentLink>
          <role>SIGN or CC</role>
        </signatoryLink>
      </SignatoryLink>
    </SignDocumentResponse>
  </soap12:Body>
</soap12:Envelope>