API - Documentation technique^v1.3

Environnements

Production

Endpoint: https://www.contrat-prive.com/webService/
WSDL: https://www.contrat-prive.com/webService/api.wsdl

Plateforme de test

Endpoint: https://sandbox.contrat-prive.com/webService/
WSDL: https://sandbox.contrat-prive.com/webService/api.wsdl

Apis

Vérification des paramètres de connexion

Operation: checkConnexion
Input: checkConnexionRequest
Output: checkConnexionResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:checkConnexionRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
    </api:checkConnexionRequest>
  </soapenv:Body>
</soapenv:Envelope>

success

boolean

Requis

true si la connexion s'est bien déroulée, false sinon.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:checkConnexionResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
    </ns2:checkConnexionResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Aucun

˄ Remonter ˄

Création d'un contrat

Operation: contractCreate
Input: contractCreateRequest
Output: contractCreateResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
contract	group	Requis	[1..1]
title	string	Requis	Titre du contrat
language	enum	Requis	Langue du contrat
signatureRequired	boolean	Requis	Caractère obligatoire des signatures
type	enum	Facultatif	Type de contrat (custom par défaut)
signDueDate	date	Facultatif	Date limite de signature
autoClosingDate	date	Facultatif	Date de clôture automatique
signPage	boolean	Facultatif	Ajout d'une page de signature (vrai par défaut)
mainDocuments	group	Requis	[1..1]
document	group	Requis	[1..n]
filename	string	Requis	Nom du fichier
title	string	Requis	Nom du fichier affiché à l'utilisateur
contentType	string	Requis	Type de fichier (ex : application/pdf)
data	base64Binary	Requis	Contenu du fichier
annexeDocuments	group	Facultatif	[0..1]
document	group	Requis	[1..n]
filename	string	Requis	Nom du fichier
title	string	Requis	Nom du fichier affiché à l'utilisateur
contentType	string	Requis	Type de fichier (ex : application/pdf)
data	base64Binary	Requis	Contenu du fichier
signatories	group	Requis	[1..1]
signatory	group	Requis	[1..n]
externalId	string	Requis	Référence externe du signataire dans le SI client
firstname	string	Requis	Prénom du signataire
lastname	string	Requis	Nom de famille du signataire
email	string	Requis	Email du signataire
phoneNumber	string	Requis	Numéro de téléphone portable du signataire
organization	string	Facultatif	Nom de l'entreprise du signataire
payment	int	Facultatif	Montant de l'acompte que doit payer le signataire. Le montant doit être exprimé en centime et être compris entre 0 et 50000
signPosition	group	Facultatif	[0..1]
page	int	Requis	Numéro de page ou apposer la signature.
x1	int	Requis	Coordonnées en X du point haut gauche
y1	int	Requis	Coordonnées en Y du point haut gauche
x2	int	Requis	Coordonnées en X du point bas à droite
y2	int	Requis	Coordonnées en Y du point bas à droite
actions	group	Requis	[1..1]
submit	boolean	Requis	Si vrai soumet à signature le contrat, si faux le contrat est enregistré en brouillon
notify	group	Requis	[1..1]
signatory	boolean	Requis	Envoi des notifications aux signataires
owner	boolean	Requis	Envoi des notifications au déposant
submitMessage	string	Facultatif	Corps du message de notification à envoyer aux signataires.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:contractCreateRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:contract>
        <api:title>Contrat de location</api:title>
        <api:language>fr</api:language>
        <api:signatureRequired>true</api:signatureRequired>
        <api:type>custom</api:type>
        <api:signDueDate>2017-12-31T23:23:59</api:signDueDate>
        <api:autoClosingDate>2016-08-31T23:23:59</api:autoClosingDate>
        <api:signPage>true</api:signPage>
      </api:contract>
      <api:mainDocuments>
        <api:document>
          <api:filename>model.pdf</api:filename>
          <api:title>Contrat de location</api:title>
          <api:contentType>application/pdf</api:contentType>
          <api:data>JVBERi0xLjUNC...jw8L1R5cGUgL1Bh</api:data>
        </api:document>
      </api:mainDocuments>
      <api:annexeDocuments>
        <api:document>
          <api:filename>plan.doc</api:filename>
          <api:title>Plan du bâtiment</api:title>
          <api:contentType>application/msword</api:contentType>
          <api:data>UEsDBBQAAAgA...3kZexjIMJwA</api:data>
        </api:document>
      </api:annexeDocuments>
      <api:signatories>
        <api:signatory>
          <api:externalId>EXT-123</api:externalId>
          <api:firstname>Marie</api:firstname>
          <api:lastname>Dumont</api:lastname>
          <api:email>marie.dumont@client.fr</api:email>
          <api:phoneNumber>+336123456789</api:phoneNumber>
          <api:organization></api:organization>
          <api:payment>2500</api:payment>
          <api:signPosition>
            <api:page>1</api:page>
            <api:x1>310</api:x1>
            <api:y1>100</api:y1>
            <api:x2>560</api:x2>
            <api:y2>20</api:y2>
          </api:signPosition>
        </api:signatory>
      </api:signatories>
      <api:actions>
        <api:submit>true</api:submit>
      </api:actions>
      <api:notify>
        <api:signatory>true</api:signatory>
        <api:owner>true</api:owner>
        <api:submitMessage></api:submitMessage>
      </api:notify>
    </api:contractCreateRequest>
  </soapenv:Body>
</soapenv:Envelope>

publicId	string	Requis	La référence publique du contrat
signatories	group	Requis	[1..n]
signatory	group	Requis	[1..n]
publicId	string	Requis	La référence publique du signataire
externalId	string	Requis	La référence externe du signataire renseignée en entrée

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:contractCreateResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:publicId>24956c81-fc97-438c-8620-81f69f7324e8</ns2:publicId>
      <ns2:signatories>
        <ns2:signatory>
          <ns2:publicId>2fa488dc-c817-4d31-9719-28c4d872eea1</ns2:publicId>
          <ns2:externalId>EXT-123</ns2:externalId>
        </ns2:signatory>
      </ns2:signatories>
    </ns2:contractCreateResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 106, 301, 302, 303

˄ Remonter ˄

Détail d'un contrat

Operation: contractDetail
Input: contractDetailRequest
Output: contractDetailResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:contractDetailRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
    </api:contractDetailRequest>
  </soapenv:Body>
</soapenv:Envelope>

contract	group	Requis	[1..1]
publicId	string	Requis	La référence publique du contrat
title	string	Requis	Titre du contrat
closingDate	date	Requis	Date du statut clôturant
autoClosingDate	date	Requis	Date de clôture automatique
createDate	date	Requis	Date de création
signDueDate	date	Requis	Date limite de signature
submitDate	date	Requis	Date de signature
signatureRequired	boolean	Requis	Caractère obligatoire des signatures
status	enum	Requis	Statut du contrat
type	enum	Requis	Type de contrat
amountPaid	int	Requis	Montant de la somme des acomptes payés par les signataires. Le montant est exprimé en centime.
signatories	group	Requis	[1..1]
signatory	group	Requis	[1..n]
publicId	string	Requis	La référence publique du signataire
actionDate	date	Requis	Date d'action
email	string	Requis	Email du signataire
firstname	string	Requis	Prénom du signataire
lastname	string	Requis	Nom de famille du signataire
phoneNumber	string	Requis	Numéro de téléphone portable du signataire
status	enum	Requis	Statut du contrat
organization	string	Facultatif	Nom de l'entreprise du signataire
payment	int	Facultatif	Montant de l'acompte que doit payer le signataire. Le montant est exprimé en centime.
mainDocuments	group	Requis	[1..1]
document	group	Requis	[1..n]
publicId	string	Requis	La référence publique du document
contentType	string	Requis	Type de fichier (ex : application/pdf)
extension	string	Requis	Extension du fichier
filename	string	Requis	Nom du fichier
title	string	Requis	Nom du fichier affiché à l'utilisateur
numberOfPages	int	Requis	Nombre de page
size	long	Requis	Taille en octet du fichier
data	base64Binary	Requis	Contenu du fichier
dataSigned	base64Binary	Facultatif	Contenu du fichier signé
annexeDocuments	group	Facultatif	[0..1]
document	group	Requis	[1..n]
publicId	string	Requis	La référence publique du document
contentType	string	Requis	Type de fichier (ex : application/pdf)
extension	string	Requis	Extension du fichier
filename	string	Requis	Nom du fichier
title	string	Requis	Nom du fichier affiché à l'utilisateur
numberOfPages	int	Requis	Nombre de page
size	long	Requis	Taille en octet du fichier
data	base64Binary	Requis	Contenu du fichier
log	base64Binary	Requis	Fichier d'historique des actions du contrat

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:contractDetailResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:contract>
        <ns2:publicId>24956c81-fc97-438c-8620-81f69f7324e8</ns2:publicId>
        <ns2:title>Contrat de location</ns2:title>
        <ns2:closingDate>2016-11-01T11:23:45</ns2:closingDate>
        <ns2:autoClosingDate>2017-08-31T11:23:45</ns2:autoClosingDate>
        <ns2:createDate>2016-10-27T10:11:47</ns2:createDate>
        <ns2:signDueDate>2016-12-31T23:23:59</ns2:signDueDate>
        <ns2:submitDate>2016-11-01T11:23:45</ns2:submitDate>
        <ns2:signatureRequired>true</ns2:signatureRequired>
        <ns2:status>closed</ns2:status>
        <ns2:type>custom</ns2:type>
        <ns2:amountPaid>2500</ns2:amountPaid>
      </ns2:contract>
      <ns2:signatories>
        <ns2:signatory>
          <ns2:publicId>2fa488dc-c817-4d31-9719-28c4d872eea1</ns2:publicId>
          <ns2:actionDate>2016-11-01T11:23:45</ns2:actionDate>
          <ns2:email>marie.dumont@client.fr</ns2:email>
          <ns2:firstname>Marie</ns2:firstname>
          <ns2:lastname>Dumont</ns2:lastname>
          <ns2:phoneNumber>+336123456789</ns2:phoneNumber>
          <ns2:status>waiting</ns2:status>
          <ns2:organization></ns2:organization>
          <ns2:payment>2500</ns2:payment>
        </ns2:signatory>
      </ns2:signatories>
      <ns2:mainDocuments>
        <ns2:document>
          <ns2:publicId></ns2:publicId>
          <ns2:contentType>application/pdf</ns2:contentType>
          <ns2:extension>pdf</ns2:extension>
          <ns2:filename>model.pdf</ns2:filename>
          <ns2:title>Contrat de location</ns2:title>
          <ns2:numberOfPages>3</ns2:numberOfPages>
          <ns2:size>25178</ns2:size>
          <ns2:data>JVBERi0xLjUNC...jw8L1R5cGUgL1Bh</ns2:data>
          <ns2:dataSigned>JVBERi0xLjUNC...jw8L1R5cGUgL1Bh</ns2:dataSigned>
        </ns2:document>
      </ns2:mainDocuments>
      <ns2:annexeDocuments>
        <ns2:document>
          <ns2:publicId></ns2:publicId>
          <ns2:contentType>application/msword</ns2:contentType>
          <ns2:extension>pdf</ns2:extension>
          <ns2:filename>plan.doc</ns2:filename>
          <ns2:title>Plan du bâtiment</ns2:title>
          <ns2:numberOfPages>3</ns2:numberOfPages>
          <ns2:size>25178</ns2:size>
          <ns2:data>UEsDBBQAAAgA...3kZexjIMJwA</ns2:data>
        </ns2:document>
      </ns2:annexeDocuments>
      <ns2:log>L1R5cGUgLjUNC...jw8L1VBERi0xBh</ns2:log>
    </ns2:contractDetailResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101, 102

˄ Remonter ˄

Liste des contrats

Operation: contractList
Input: contractListRequest
Output: contractListResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
createDate	group	Facultatif	[0..1]
from	date	Facultatif	Date de création (début)
to	date	Facultatif	Date de création (fin)
signDueDate	group	Facultatif	[0..1]
from	date	Facultatif	Date de limite de signataure (début)
to	date	Facultatif	Date de limite de signataure (fin)

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:contractListRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:createDate>
        <api:from></api:from>
        <api:to></api:to>
      </api:createDate>
      <api:signDueDate>
        <api:from></api:from>
        <api:to></api:to>
      </api:signDueDate>
    </api:contractListRequest>
  </soapenv:Body>
</soapenv:Envelope>

contracts	group	Requis	[1..1]
contract	group	Facultatif	[0..n]
publicId	string	Requis	La référence publique du contrat
status	enum	Requis	Statut du contrat

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:contractListResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:contracts>
        <ns2:contract>
          <ns2:publicId>24956c81-fc97-438c-8620-81f69f7324e8</ns2:publicId>
          <ns2:status>closed</ns2:status>
        </ns2:contract>
      </ns2:contracts>
    </ns2:contractListResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002

˄ Remonter ˄

Suppression d'un contrat

Operation: contractDelete
Input: contractDeleteRequest
Output: contractDeleteResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:contractDeleteRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
    </api:contractDeleteRequest>
  </soapenv:Body>
</soapenv:Envelope>

success

boolean

Requis

true si la suppression s'est bien déroulée

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:contractDeleteResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
    </ns2:contractDeleteResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101

˄ Remonter ˄

Annulation d'un contrat

Operation: contractCancel
Input: contractCancelRequest
Output: contractCancelResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat
signatoryId	string	Facultatif	La référence publique du signataire

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:contractCancelRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
      <api:signatoryId>2fa488dc-c817-4d31-9719-28c4d872eea1</api:signatoryId>
    </api:contractCancelRequest>
  </soapenv:Body>
</soapenv:Envelope>

success

boolean

Requis

true si l'annulation s'est bien déroulée

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:contractCancelResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
    </ns2:contractCancelResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101, 201

˄ Remonter ˄

Finalisation d'un contrat

Operation: contractFinalize
Input: contractFinalizeRequest
Output: contractFinalizeResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:contractFinalizeRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
    </api:contractFinalizeRequest>
  </soapenv:Body>
</soapenv:Envelope>

success

boolean

Requis

true si la finalisation s'est bien déroulée

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:contractFinalizeResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
    </ns2:contractFinalizeResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101

˄ Remonter ˄

Envoi du code SMS à un signataire

Operation: signatorySendSms
Input: signatorySendSmsRequest
Output: signatorySendSmsResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat
signatoryId	string	Requis	La référence publique du signataire

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:signatorySendSmsRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
      <api:signatoryId>2fa488dc-c817-4d31-9719-28c4d872eea1</api:signatoryId>
    </api:signatorySendSmsRequest>
  </soapenv:Body>
</soapenv:Envelope>

success

boolean

Requis

true si l'envoi s'est bien déroulé

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:signatorySendSmsResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
    </ns2:signatorySendSmsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101, 201

˄ Remonter ˄

Envoi du code SMS à tous les signataires

Operation: signatorySendAllSms
Input: signatorySendAllSmsRequest
Output: signatorySendAllSmsResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:signatorySendAllSmsRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
    </api:signatorySendAllSmsRequest>
  </soapenv:Body>
</soapenv:Envelope>

signatories	group	Requis	[1..n]
signatory	group	Requis	[1..n]
publicId	string	Requis	La référence publique du contrat
status	enum	Requis	Le résultat de l'envoi du SMS pour le signataire

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:signatorySendAllSmsResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:signatories>
        <ns2:signatory>
          <ns2:publicId>24956c81-fc97-438c-8620-81f69f7324e8</ns2:publicId>
          <ns2:status>success</ns2:status>
        </ns2:signatory>
      </ns2:signatories>
    </ns2:signatorySendAllSmsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101, 201

˄ Remonter ˄

Envoi du code SMS à un signataire pour plusieurs contrats

Operation: signatorySendOneSms
Input: signatorySendOneSmsRequest
Output: signatorySendOneSmsResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
signatories	group	Requis	[1..1]
signatory	group	Requis	[1..n]
contractId	string	Requis	La référence publique du contrat
signatoryId	string	Requis	La référence publique du signataire
language	enum	Facultatif	Langue du SMS

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:signatorySendOneSmsRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:signatories>
        <api:signatory>
          <api:contractId>24956c81-fc97-438c-8620-81f69f7324e8</api:contractId>
          <api:signatoryId>2fa488dc-c817-4d31-9719-28c4d872eea1</api:signatoryId>
        </api:signatory>
      </api:signatories>
      <api:language>fr</api:language>
    </api:signatorySendOneSmsRequest>
  </soapenv:Body>
</soapenv:Envelope>

success	boolean	Requis	true si l'envoi s'est bien déroulé
signatories	group	Requis	[1..n]
signatory	group	Requis	[1..n]
publicId	string	Requis	La référence publique du signataire
status	enum	Requis	Le résultat de l'envoi du SMS pour le signataire

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:signatorySendOneSmsResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
      <ns2:signatories>
        <ns2:signatory>
          <ns2:publicId>2fa488dc-c817-4d31-9719-28c4d872eea1</ns2:publicId>
          <ns2:status>success</ns2:status>
        </ns2:signatory>
      </ns2:signatories>
    </ns2:signatorySendOneSmsResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101, 201, 206

˄ Remonter ˄

Signature du contrat par un signataire

Operation: signatorySign
Input: signatorySignRequest
Output: signatorySignResponse

requestToken	group	Requis	[1..1]
apiKey	string	Requis	« Clé d'API », disponible dans la partie « mon compte »
apiUser	string	Requis	« Clé publique », disponible dans la partie « mon compte »
publicId	string	Requis	La référence publique du contrat
signatoryId	string	Requis	La référence publique du signataire
code	string	Requis	La clé de signature reçue par SMS

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://adminext.com/contratprive/ws/operation/api">
  <soapenv:Header/>
  <soapenv:Body>
    <api:signatorySignRequest>
      <api:requestToken>
        <api:apiKey>0c3607ad-1b3c-4d77-b058-06852cf45c2b</api:apiKey>
        <api:apiUser>aRf5eS6a789</api:apiUser>
      </api:requestToken>
      <api:publicId>24956c81-fc97-438c-8620-81f69f7324e8</api:publicId>
      <api:signatoryId>2fa488dc-c817-4d31-9719-28c4d872eea1</api:signatoryId>
      <api:code>1234</api:code>
    </api:signatorySignRequest>
  </soapenv:Body>
</soapenv:Envelope>

success	boolean	Requis	true si la signature s'est bien déroulée
paymentRequired	boolean	Requis	true si le signataire doit encore payer un acompte, false sinon.

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
  <SOAP-ENV:Header/>
  <SOAP-ENV:Body>
    <ns2:signatorySignResponse xmlns:ns2="http://adminext.com/contratprive/ws/operation/api">
      <ns2:success>true</ns2:success>
      <ns2:paymentRequired></ns2:paymentRequired>
    </ns2:signatorySignResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

002, 003, 101, 102, 103, 104, 201, 202, 203

˄ Remonter ˄

Codes d'erreur

Erreurs génériques

ResultCode ResultMessage Message

001 UNEXPECTED Erreur interne

002 WRONG_API_KEY Informations de connexion incorrectes

003 OPERATION_NOT_ALLOWED Opération non autorisée

ResultCode	ResultMessage	Message
001	UNEXPECTED	Erreur interne
002	WRONG_API_KEY	Informations de connexion incorrectes
003	OPERATION_NOT_ALLOWED	Opération non autorisée

Erreurs sur les contrats

ResultCode ResultMessage Message

101 CONTRACT_NOT_FOUND Contrat non trouvé

102 CONTRACT_NOT_SUBMITTED Contrat non soumis, annulé ou validé

103 CONTRACT_SIGNED Le contrat est signé

104 CONTRACT_CLOSED Le contrat à un statut clôturant

105 CONTRACT_NOT_SIGNED Le contrat n'est pas signé

106 CONTRACT_SUBMIT_RULES Les conditions pour soumettre le contrat ne sont pas respectées : dates limites dans le passé, crédits insuffisants, informations bancaires non renseignées pour le déposant (cas des acomptes)

ResultCode	ResultMessage	Message
101	CONTRACT_NOT_FOUND	Contrat non trouvé
102	CONTRACT_NOT_SUBMITTED	Contrat non soumis, annulé ou validé
103	CONTRACT_SIGNED	Le contrat est signé
104	CONTRACT_CLOSED	Le contrat à un statut clôturant
105	CONTRACT_NOT_SIGNED	Le contrat n'est pas signé
106	CONTRACT_SUBMIT_RULES	Les conditions pour soumettre le contrat ne sont pas respectées : dates limites dans le passé, crédits insuffisants, informations bancaires non renseignées pour le déposant (cas des acomptes)

Erreurs sur les signataires

ResultCode ResultMessage Message

201 SIGNATORY_NOT_FOUND Signataire non trouvé

202 SIGNATORY_WRONG_SMS_CODE Mauvais code SMS

203 SIGNATORY_ALREADY_SIGNED Le signataire à déjà signé le contrat

204 SIGNATORY_PAIMENT_REQUIRED Paiement requis

205 SIGNATORY_TOO_MUCH_SMS Quota de SMS atteint pour ce signataire

206 SIGNATORY_MISMATCH_PHONE_NUMBER Les signataires n'ont pas tous le même numéro de téléphone

ResultCode	ResultMessage	Message
201	SIGNATORY_NOT_FOUND	Signataire non trouvé
202	SIGNATORY_WRONG_SMS_CODE	Mauvais code SMS
203	SIGNATORY_ALREADY_SIGNED	Le signataire à déjà signé le contrat
204	SIGNATORY_PAIMENT_REQUIRED	Paiement requis
205	SIGNATORY_TOO_MUCH_SMS	Quota de SMS atteint pour ce signataire
206	SIGNATORY_MISMATCH_PHONE_NUMBER	Les signataires n'ont pas tous le même numéro de téléphone

Erreurs sur les fichiers

ResultCode ResultMessage Message

301 FILE_MIMETYPE_NOT_ALLOWED Type de fichier non autorisé

302 FILE_CONVERSION_ERROR Impossible de convertir le document

303 FILE_READONLY Le fichier est protégé ou en lecture seule

304 FILE_SIZE_TOO_LARGE La taille du fichier est trop grande

˄ Remonter ˄

ResultCode	ResultMessage	Message
301	FILE_MIMETYPE_NOT_ALLOWED	Type de fichier non autorisé
302	FILE_CONVERSION_ERROR	Impossible de convertir le document
303	FILE_READONLY	Le fichier est protégé ou en lecture seule
304	FILE_SIZE_TOO_LARGE	La taille du fichier est trop grande

API - Documentation techniquev1.3

Environnements

Production

Plateforme de test

Apis

Vérification des paramètres de connexion

Création d'un contrat

Détail d'un contrat

Liste des contrats

Suppression d'un contrat

Annulation d'un contrat

Finalisation d'un contrat

Envoi du code SMS à un signataire

Envoi du code SMS à tous les signataires

Envoi du code SMS à un signataire pour plusieurs contrats

Signature du contrat par un signataire

Codes d'erreur

Erreurs génériques ResultCode ResultMessage Message 001 UNEXPECTED Erreur interne 002 WRONG_API_KEY Informations de connexion incorrectes 003 OPERATION_NOT_ALLOWED Opération non autorisée

API - Documentation technique^v1.3

Erreurs génériques

ResultCode ResultMessage Message

001 UNEXPECTED Erreur interne

002 WRONG_API_KEY Informations de connexion incorrectes

003 OPERATION_NOT_ALLOWED Opération non autorisée