api.digiposte.fr
Open in
urlscan Pro
46.255.129.14
Public Scan
Submitted URL: https://api.digiposte.fr/
Effective URL: https://api.digiposte.fr/docs/
Submission Tags: falconsandbox
Submission: On September 23 via api from US — Scanned from FR
Effective URL: https://api.digiposte.fr/docs/
Submission Tags: falconsandbox
Submission: On September 23 via api from US — Scanned from FR
Form analysis 336 forms found in the DOM
<form id="api_selector">
<div class="input" style="display:none;">
<input placeholder="http://example.com/api" id="input_baseUrl" name="baseUrl" type="text">
</div>
<div class="input">
<select id="api_select">
<option value="/api/v2.0/swagger.json">2.0</option>
<option value="/api/v3/swagger.json" selected="selected">3</option>
</select>
</div>
<div class="input">
<select id="api_consumer">
<option value="PARTNER">PARTNER</option>
<option value="CLIENT" selected="selected">CLIENT</option>
</select>
</div>
<div class="input"><a id="explore" href="#">Explore</a></div>
<div id="auth_link" class="input logout"><a href="https://secure.digiposte.fr/oauth/authorize?response_type=code&client_id=client_id_swagger&redirect_uri=https://api.digiposte.fr/ui/token">Log in</a></div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">account_input</td>
<td>
<textarea class="body-textarea" name="account_input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>L'identifiant ccu de l'utilisateur et le code Regate (falcultatif)</p>
</td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AccountInput {</span>
<div><span class="propName true">ccu_user_id</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">code_regate</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">ccu_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">code_regate</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Missing parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td>Access denied</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>You don't have the rights to access this resource</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">account_input</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="account_input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>L'identifiant ccu de l'utilisateur et le code Regate (falcultatif)</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">AccountCreationInput {</span>
<div><span class="propName true">ccu_user_id</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">route_code</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">ccu_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">route_code</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Missing parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">401</td>
<td>Access denied</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>You don't have the rights to access this resource</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
<option value="text/json">text/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ApprovalInput {</span>
<div><span class="propName true">client_id</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">client_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tag</td>
<td>
<textarea class="body-textarea" name="tag"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The tag of the document. Can pass multiple tags separated by | or , char</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">hash</td>
<td>
<textarea class="body-textarea" name="hash"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash value of the document content</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">algo</td>
<td>
<textarea class="body-textarea" name="algo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash algorithm to check the hash</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">folder_id</td>
<td>
<textarea class="body-textarea" name="folder_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Folder ID where the document will be stored</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">favorite</td>
<td>
<select class="parameter" name="favorite">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Favorite document ?</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code">health_document</td>
<td>
<select class="parameter" name="health_document">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Health document</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">nature_id</td>
<td>
<textarea class="body-textarea" name="nature_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Nature type of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">X-AuthorizeSender</td>
<td>
<select class="parameter" name="X-AuthorizeSender">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>header</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code required">archive</td>
<td>
<input type="file" name="archive">
</td>
<td>
<strong><span class="markdown">
<p>The file to archive</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document hash is wrong</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The document to upload is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tag</td>
<td>
<textarea class="body-textarea" name="tag"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The tag of the document. Can pass multiple tags separated by | or , char</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">hash</td>
<td>
<textarea class="body-textarea" name="hash"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash value of the document content</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">algo</td>
<td>
<textarea class="body-textarea" name="algo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash algorithm to check the hash</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">timestamp</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="timestamp"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document timestamp</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">latitude</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="latitude"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document latitude</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">double</span></td>
</tr>
<tr>
<td class="code required">longitude</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="longitude"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document longitude</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">double</span></td>
</tr>
<tr>
<td class="code required">hdop</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="hdop"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document hdop</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">folder_id</td>
<td>
<textarea class="body-textarea" name="folder_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Folder ID where the document will be stored</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">favorite</td>
<td>
<select class="parameter" name="favorite">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Favorite document ?</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code">health_document</td>
<td>
<select class="parameter" name="health_document">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Health document</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">X-AuthorizeSender</td>
<td>
<select class="parameter" name="X-AuthorizeSender">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>header</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code required">archive</td>
<td>
<input type="file" name="archive">
</td>
<td>
<strong><span class="markdown">
<p>The file to archive</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document to upload is empty</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The document to upload is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document.</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">subtitle</td>
<td>
<textarea class="body-textarea" name="subtitle"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The subtitle of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">summary</td>
<td>
<textarea class="body-textarea" name="summary"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The summary of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tag</td>
<td>
<textarea class="body-textarea" name="tag"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The tag of the document. Can pass multiple tags separated by | or , char</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">hash</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="hash"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The hash value of the document content.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">algo</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="algo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The hash algorithm to check the hash.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">location</td>
<td>
<textarea class="body-textarea" name="location"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The location (inbox, classeur...)</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">type</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="type"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The type (facture, ...)</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">folder_id</td>
<td>
<textarea class="body-textarea" name="folder_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Folder ID where the document will be stored</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">favorite</td>
<td>
<select class="parameter" name="favorite">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Favorite document ?</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code required">archive</td>
<td>
<input type="file" name="archive">
</td>
<td>
<strong><span class="markdown">
<p>The file to archive</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document to upload is empty</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The document to upload is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tag</td>
<td>
<textarea class="body-textarea" name="tag"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The tag of the document. Can pass multiple tags separated by | or , char</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">folder_id</td>
<td>
<textarea class="body-textarea" name="folder_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Folder ID where the document will be stored</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">favorite</td>
<td>
<select class="parameter" name="favorite">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Favorite document ?</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code">health_document</td>
<td>
<select class="parameter" name="health_document">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Health document</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">nature_id</td>
<td>
<textarea class="body-textarea" name="nature_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Document nature</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">archives</td>
<td>
<input type="file" name="archives">
</td>
<td>
<strong><span class="markdown">
<p>The files to use to generate the PDF document</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not enough space left on the user strongbox</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The total size of the files to merge is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tag</td>
<td>
<textarea class="body-textarea" name="tag"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The tag of the document. Can pass multiple tags separated by | or , char</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">timestamp</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="timestamp"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document timestamp</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">latitude</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="latitude"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document latitude</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">double</span></td>
</tr>
<tr>
<td class="code required">longitude</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="longitude"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document longitude</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">double</span></td>
</tr>
<tr>
<td class="code required">hdop</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="hdop"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The document hdop</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">folder_id</td>
<td>
<textarea class="body-textarea" name="folder_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Folder ID where the document will be stored</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">favorite</td>
<td>
<select class="parameter" name="favorite">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Favorite document ?</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code">health_document</td>
<td>
<select class="parameter" name="health_document">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Health document</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code required">archives</td>
<td>
<input type="file" name="archives">
</td>
<td>
<strong><span class="markdown">
<p>The files to use to generate the PDF document</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not enough space left on the user strongbox</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The total size of the files to merge is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>the user don't have a avatar</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">avatar</td>
<td>
<input type="file" name="avatar">
</td>
<td>
<strong><span class="markdown">
<p>The avatar to upload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Upload OK</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Avatar has been deleted.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">transactionId</td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">transactionId</td>
<td>
<input class="parameter required" minlength="1" name="transactionId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TwoFaInput {</span>
<div><span class="propName false">code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">code</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">picture</td>
<td>
<input type="file" name="picture">
</td>
<td>
<strong><span class="markdown">
<p>The picture to upload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Upload OK</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Photo has been deleted.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Your account cannot access to this resource. </td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">accepted</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="accepted"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>accept invitation ?</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactInvitationData {</span>
<div><span class="propName false">accepted</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">accepted</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Contact not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>user can't answer his own invitation</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="user_procedure_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the id of the procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserProcedureIdInput {</span>
<div><span class="propName false">user_procedure_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Procedure not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the procedure</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Procedure not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">since_id</td>
<td>
<input class="parameter" minlength="0" name="since_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created after the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">max_id</td>
<td>
<input class="parameter" minlength="0" name="max_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created before the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The type of the returned items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">status</td>
<td>
<select class="parameter" name="status">
<option selected="" value=""></option>
<option value="ARCHIVED">ARCHIVED</option>
<option value="NOT_ARCHIVED">NOT_ARCHIVED</option>
</select>
</td>
<td class="markdown">
<p>Status of timeline events</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add contact member to current user's contact universe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactInput {</span>
<div><span class="propWrap"><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">relationship_type</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">phone</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">relationship_type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>the given email is already used for another relationship</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add contact member to current user's contact universe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactInput {</span>
<div><span class="propWrap"><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">phone</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">relationship_type</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">phone</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">relationship_type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the contact member</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the id of the document</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdInput {</span>
<div><span class="propName false">document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Member not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>the given document id has been already added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du contact</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>User not allowed to get documents from share</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>share not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du contact</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Les ids des documents à mettre dans le partage</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">IdSet {</span>
<div><span class="propName true">ids</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Document list is emtpty</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>User not allowed to add documents to share</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>share not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Document(s) already exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du contact</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Les ids des documents à mettre dans le partage</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">IdSet {</span>
<div><span class="propName true">ids</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Document(s) has been deleted from share</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>User not allowed to delete documents from share</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Share not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du contact</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ContactShareCopy {</span>
<div><span class="propName false">folder_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">documents</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">folder_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">documents</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>User not allowed to access to document</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du contact</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document à télécharger</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>User not allowed to get documents from share</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>share not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Document(s) is not share</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">login</td>
<td>
<input class="parameter required" minlength="1" name="login" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">email</td>
<td>
<input class="parameter required" minlength="1" name="email" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>This login or email are invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">email</td>
<td>
<input class="parameter required" minlength="1" name="email" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">uri</td>
<td>
<input class="parameter" minlength="0" name="uri" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">mail_valid</td>
<td>
<select class="parameter" name="mail_valid">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">ccu_linked</td>
<td>
<select class="parameter" name="ccu_linked">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The new secret question</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserCredentialsQuestion {</span>
<div><span class="propWrap"><span class="propName false">secret_question</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">secret_question</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[\p{InCombiningDiacriticalMarks}\p{L}\d\s ?',-]{1,128}$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">secret_question_index</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_question_answer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">valid_secret_question_data</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">secret_question</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_question_index</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">secret_question_answer</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">valid_secret_question_data</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required">login</td>
<td>
<input class="parameter required" minlength="1" name="login" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user's login</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">uri</td>
<td>
<input class="parameter" minlength="0" name="uri" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The URI of reset link</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">ccu</td>
<td>
<select class="parameter" name="ccu">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">type</td>
<td>
<select class="parameter" name="type">
<option selected="" value=""></option>
<option value="PERSON">PERSON</option>
<option value="COMPANY">COMPANY</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid request parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>the given answer matches the user secret question</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The password to verify</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RawPasswordToVerifyData {</span>
<div><span class="propName false">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">password</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>the given password is incorrect</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The old password, and the new password</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RawPasswordUpdateData {</span>
<div><span class="propName false">old_password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">new_password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">old_password</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">new_password</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The new password is too leak</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td>the old password is incorrect</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data for update login payload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LoginChangeInput {</span>
<div><span class="propName false">new_login</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">old_login</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">new_login</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">old_login</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">password</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>the given password is incorrect</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">code</td>
<td>
<input class="parameter required" minlength="1" name="code" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The validation code</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">token</td>
<td>
<input class="parameter required" minlength="1" name="token" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>There is no user associated to this code</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PartialAccountTypedInput {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">birth_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">birth_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">user_type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">user_type</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^(PERSON)|(COMPANY)$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">company_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">company_mandatory_attributs_set_or_null</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">birth_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">user_type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">company_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">company_mandatory_attributs_set_or_null</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>le user_id est manquant</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>le partenaire n'est pas propriétaire du compte</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>utilisateur non trouvé</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>le compte a déjà été transformé</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the that will be created</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeviceData {</span>
<div><span class="propName true">token</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">type</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">version</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">token</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">version</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td>the new association was created</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Unknown device type or empty token</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknown device</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the device to delete</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DeviceData {</span>
<div><span class="propName true">token</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">type</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">version</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">token</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">version</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td>the new association was deleted</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Unknown device type or empty token</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">tags</td>
<td>
<input class="parameter required" minlength="1" name="tags" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Tags are not properly formatted</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Reminders not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Internal error</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">read_status</td>
<td>
<select class="parameter" name="read_status">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>path</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">favorite_status</td>
<td>
<select class="parameter" name="favorite_status">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>path</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document to mark as read/unread must not be already in this state</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Title and date of reminder that will be created</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ReminderInput {</span>
<div><span class="propName true">title</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">date</span> (<span class="propType">date-time</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.467Z"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Title or date are invalids</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>document not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Internal error</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document to delete must be in trash</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">new_name</td>
<td>
<input class="parameter required" minlength="1" name="new_name" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Certified document cannot be renamed</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du document à télécharger</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The document doesn't exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document to classify must be in inbox</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The search criteria</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ChooseDocsCriteria {</span>
<div><span class="propName false">natures</span> (<span class="propType">Array[NatureCriteria]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">start_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName false">end_date</span> (<span class="propType">date-time</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">NatureCriteria {</span>
<div><span class="propName true">nature_pid</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">limit</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">natures</span>": <span class="value">[
{
"<span class="attribute">nature_pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">limit</span>": <span class="value"><span class="number">0</span>
}</span>
]</span>,
"<span class="attribute">start_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.468Z"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.468Z"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="FILENAME">FILENAME</option>
<option value="SIZE">SIZE</option>
<option value="CREATION_DATE">CREATION_DATE</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">use_finder_search</td>
<td>
<select class="parameter" name="use_finder_search">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Use finder backend for research</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Nature PID is not a valid value.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">partnerUserId</td>
<td>
<input class="parameter required" minlength="1" name="partnerUserId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="TYPE">TYPE</option>
<option value="TITLE">TITLE</option>
<option value="FILENAME">FILENAME</option>
<option value="AUTHOR_NAME">AUTHOR_NAME</option>
<option value="CREATION_DATE">CREATION_DATE</option>
<option value="WAS_READ">WAS_READ</option>
<option value="LOCATION">LOCATION</option>
<option value="IS_SHARED">IS_SHARED</option>
<option value="SIZE">SIZE</option>
<option value="DIGISHOOT">DIGISHOOT</option>
<option value="CHARGEABLE_AMOUNT">CHARGEABLE_AMOUNT</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">partner_user_id</td>
<td>
<input class="parameter required" minlength="1" name="partner_user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad request</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">partner_user_id</td>
<td>
<input class="parameter required" minlength="1" name="partner_user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdsInput {</span>
<div><span class="propName true">document_ids</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad request</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">sender_id</td>
<td>
<input class="parameter required" minlength="1" name="sender_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">partner_user_id</td>
<td>
<input class="parameter required" minlength="1" name="partner_user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad request</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdsInput {</span>
<div><span class="propName true">document_ids</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad request</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="TYPE">TYPE</option>
<option value="TITLE">TITLE</option>
<option value="FILENAME">FILENAME</option>
<option value="AUTHOR_NAME">AUTHOR_NAME</option>
<option value="CREATION_DATE">CREATION_DATE</option>
<option value="WAS_READ">WAS_READ</option>
<option value="LOCATION">LOCATION</option>
<option value="IS_SHARED">IS_SHARED</option>
<option value="SIZE">SIZE</option>
<option value="DIGISHOOT">DIGISHOOT</option>
<option value="CHARGEABLE_AMOUNT">CHARGEABLE_AMOUNT</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>input with list of couple (pid, wanted)</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DynamicProcedureInput {</span>
<div><span class="propName false">natures</span> (<span class="propType">Array[DynamicProcedureItemInput]</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">extensions</span> (<span class="propType">string</span>)</div><span class="strong">}</span><br><span class="strong">DynamicProcedureItemInput {</span>
<div><span class="propName false">pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">wanted</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">natures</span>": <span class="value">[
{
"<span class="attribute">pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">wanted</span>": <span class="value"><span class="number">0</span>
}</span>
]</span>,
"<span class="attribute">extensions</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">safeOnly</td>
<td>
<select class="parameter" name="safeOnly">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>to look for documents only in safe and inbox</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="TYPE">TYPE</option>
<option value="TITLE">TITLE</option>
<option value="FILENAME">FILENAME</option>
<option value="AUTHOR_NAME">AUTHOR_NAME</option>
<option value="CREATION_DATE">CREATION_DATE</option>
<option value="WAS_READ">WAS_READ</option>
<option value="LOCATION">LOCATION</option>
<option value="IS_SHARED">IS_SHARED</option>
<option value="SIZE">SIZE</option>
<option value="DIGISHOOT">DIGISHOOT</option>
<option value="CHARGEABLE_AMOUNT">CHARGEABLE_AMOUNT</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="TYPE">TYPE</option>
<option value="TITLE">TITLE</option>
<option value="FILENAME">FILENAME</option>
<option value="AUTHOR_NAME">AUTHOR_NAME</option>
<option value="CREATION_DATE">CREATION_DATE</option>
<option value="WAS_READ">WAS_READ</option>
<option value="LOCATION">LOCATION</option>
<option value="IS_SHARED">IS_SHARED</option>
<option value="SIZE">SIZE</option>
<option value="DIGISHOOT">DIGISHOOT</option>
<option value="CHARGEABLE_AMOUNT">CHARGEABLE_AMOUNT</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The search criteria</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentSearch {</span>
<div><span class="propWrap"><span class="propName false">locations</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">locations</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">document_types</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">mimetypes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">text</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">sender_names</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">author_names</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">user_tags</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">user_tags_operator</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['AND' or 'OR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">user_tags_operator</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"AND", "OR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">sender_tags</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">sender_tags_operator</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['AND' or 'OR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">sender_tags_operator</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"AND", "OR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">tags</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">tags_operator</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['AND' or 'OR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">tags_operator</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"AND", "OR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">document_read</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_shared</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_digishoot</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_certified</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">creation_date_ranges</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['CURRENT_DAY' or 'CURRENT_WEEK' or
'CURRENT_MONTH' or 'CURRENT_YEAR' or 'BEFORE_CURRENT_YEAR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">creation_date_ranges</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"CURRENT_DAY", "CURRENT_WEEK", "CURRENT_MONTH", "CURRENT_YEAR", "BEFORE_CURRENT_YEAR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName false">creation_date_ranges_operator</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['AND' or 'OR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">creation_date_ranges_operator</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"AND", "OR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName false">document_sources</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['SENDER' or 'USER' or
'DIGIPOSTE']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">document_sources</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"SENDER", "USER", "DIGIPOSTE"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">references</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">favorite</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">user_removal</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">health</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_pid_inputs</span> (<span class="propType">Array[DocumentNaturePidInput]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">DocumentNaturePidInput {</span>
<div><span class="propName false">value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">locations</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">document_types</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">mimetypes</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">text</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">sender_names</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">author_names</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">user_tags</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">user_tags_operator</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">sender_tags</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">sender_tags_operator</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">tags</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">tags_operator</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">document_read</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">document_shared</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">document_digishoot</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">document_certified</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">creation_date_ranges</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">creation_date_ranges_operator</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">document_sources</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">references</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">favorite</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">user_removal</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">health</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">nature_pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_pid_inputs</span>": <span class="value">[
{
"<span class="attribute">value</span>": <span class="value"><span class="string">"string"</span>
}</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="TYPE">TYPE</option>
<option value="TITLE">TITLE</option>
<option value="FILENAME">FILENAME</option>
<option value="AUTHOR_NAME">AUTHOR_NAME</option>
<option value="CREATION_DATE">CREATION_DATE</option>
<option value="WAS_READ">WAS_READ</option>
<option value="LOCATION">LOCATION</option>
<option value="IS_SHARED">IS_SHARED</option>
<option value="SIZE">SIZE</option>
<option value="DIGISHOOT">DIGISHOOT</option>
<option value="CHARGEABLE_AMOUNT">CHARGEABLE_AMOUNT</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">406</td>
<td>Invalid search filter value for Location</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add document to user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DownloadInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">empty</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">empty</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
<option value="text/plain">text/plain</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">Array[#/definitions/PartnerOneClickDownloadRequest]</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">partNumber</td>
<td>
<input class="parameter" minlength="0" name="partNumber" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The number of archive part</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
<option value="text/plain">text/plain</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OneClickDownloadRequest {</span>
<div><span class="propName false">password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">password</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Folders and documents identifiants</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileTreeInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">check</td>
<td>
<select class="parameter" name="check">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Cannot trash because of wrong location</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Document or folder doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">action_id</td>
<td>
<input class="parameter required" minlength="1" name="action_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Cannot undo action</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Cannot rename certified document</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Folders and documents identifiants</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileTreeInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">favorite_status</td>
<td>
<select class="parameter" name="favorite_status">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>path</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>At least one document/folder is not owned by authenticated user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>At least one of the documents/folders to update the favorite status could not be found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Can't update the favorite status of so many documents/folders in a single request</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Folders and documents identifiants</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileTreeInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Cannot restore because of wrong location</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Folders and documents identifiants</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileTreeInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Cannot restore because of wrong location</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Folders and documents infos</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileTreeInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">to</td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The target folder</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Folders and documents identifiants</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FileTreeInput {</span>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">folder_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">folder_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Document or folder doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Cannot move a folder into its child folders or itself</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">FolderInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">favorite</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">parent_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">favorite</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">parent_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Folder ID</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">new_name</td>
<td>
<input class="parameter required" minlength="1" name="new_name" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad input: incorrect new name</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">check</td>
<td>
<select class="parameter" name="check">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Folder already in trash</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">sort</td>
<td>
<select class="parameter" name="sort">
<option selected="" value=""></option>
<option value="TYPE">TYPE</option>
<option value="TITLE">TITLE</option>
<option value="FILENAME">FILENAME</option>
<option value="AUTHOR_NAME">AUTHOR_NAME</option>
<option value="CREATION_DATE">CREATION_DATE</option>
<option value="WAS_READ">WAS_READ</option>
<option value="LOCATION">LOCATION</option>
<option value="IS_SHARED">IS_SHARED</option>
<option value="SIZE">SIZE</option>
<option value="DIGISHOOT">DIGISHOOT</option>
<option value="CHARGEABLE_AMOUNT">CHARGEABLE_AMOUNT</option>
</select>
</td>
<td class="markdown">
<p>The field on which you want to sort the results</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">direction</td>
<td>
<select class="parameter" name="direction">
<option selected="" value=""></option>
<option value="ASCENDING">ASCENDING</option>
<option value="DESCENDING">DESCENDING</option>
</select>
</td>
<td class="markdown">
<p>The direction in which you want to sort the results, for the given field</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>At least one parameter is incorrect (sort, direction, max_results)</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">favorite_status</td>
<td>
<select class="parameter" name="favorite_status">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>path</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Folder not in trash</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Folder not in trash</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">folder_id</td>
<td>
<input class="parameter required" minlength="1" name="folder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">to</td>
<td>
<input class="parameter" minlength="0" name="to" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The target folder</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Cannot find folder</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Cannot move a folder into its child folders or itself</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document isn't in this Good.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not user's document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Good ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No picture for this Good</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">picture</td>
<td>
<input type="file" name="picture">
</td>
<td>
<strong><span class="markdown">
<p>The picture to upload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No picture for this Good</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="user_procedure_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserProcedureIdInput {</span>
<div><span class="propName false">user_procedure_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Procedure added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's user procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>User procedure doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The user procedure is already in this Good.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a user procedure</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's user procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>User procedure isn't in this Good.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Good ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">good_data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="good_data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data of the Good</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GoodInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">buy_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">caution_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">type</span> (<span class="propType">string</span>) = <span class="propVals">['AUTOMOTIVE' or 'FURNISHING' or 'COMPUTER_MULTIMEDIA' or 'TELEPHONY' or 'CLOTH_ACCESORY' or
'JEWELLERY' or 'HOME' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY", "CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">buy_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">caution_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Not a valid Good input.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Good ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The purchase date is in the future.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Good ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="good_data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data of the Good</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">GoodInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">buy_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">caution_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">type</span> (<span class="propType">string</span>) = <span class="propVals">['AUTOMOTIVE' or 'FURNISHING' or 'COMPUTER_MULTIMEDIA' or 'TELEPHONY' or 'CLOTH_ACCESORY' or
'JEWELLERY' or 'HOME' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY", "CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">buy_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">caution_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Not a valid Good input.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The purchase date is in the future.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">since_id</td>
<td>
<input class="parameter" minlength="0" name="since_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created after the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">max_id</td>
<td>
<input class="parameter" minlength="0" name="max_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created before the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The type of the returned items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">status</td>
<td>
<select class="parameter" name="status">
<option selected="" value=""></option>
<option value="ARCHIVED">ARCHIVED</option>
<option value="NOT_ARCHIVED">NOT_ARCHIVED</option>
</select>
</td>
<td class="markdown">
<p>the object current status</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">good_id</td>
<td>
<input class="parameter required" minlength="1" name="good_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the Good</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="document_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdInput {</span>
<div><span class="propName false">document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Document added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document is already in this Good.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Health ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">health_data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="health_data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data of the Health</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HealthDataInput {</span>
<div><span class="propWrap"><span class="propName false">civility</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['M' or 'MME' or 'DR' or 'PR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">civility</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"M", "MME", "DR", "PR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">pro_type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['GENERAL_PRACTITIONER' or 'DENTIST' or 'NURSE'
or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">pro_type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"GENERAL_PRACTITIONER", "DENTIST", "NURSE", "OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">web_site</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">mail</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">phone_number</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">appointment_link</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">regular_doctor</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">photo</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">civility</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">pro_type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">web_site</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">mail</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">phone_number</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">appointment_link</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">regular_doctor</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">photo</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Not a valid Health input.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Health ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Health ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document isn't in this health item.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not user document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Health ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No avatar in this health item</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">picture</td>
<td>
<input type="file" name="picture">
</td>
<td>
<strong><span class="markdown">
<p>The picture to upload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No picture for this health item</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="user_procedure_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserProcedureIdInput {</span>
<div><span class="propName false">user_procedure_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Procedure added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's user procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>User procedure doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The user procedure is already in this Health Item.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a user procedure</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's user procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>User procedure isn't in this health item.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="health_data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data of the Health</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HealthDataCreate {</span>
<div><span class="propWrap"><span class="propName false">civility</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['M' or 'MME' or 'DR' or 'PR']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">civility</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"M", "MME", "DR", "PR"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">pro_type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['GENERAL_PRACTITIONER' or 'DENTIST' or 'NURSE'
or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">pro_type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"GENERAL_PRACTITIONER", "DENTIST", "NURSE", "OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">web_site</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">mail</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">phone_number</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">appointment_link</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">regular_doctor</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">photo</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">item_type</span> (<span class="propType">string</span>) = <span class="propVals">['MEDICAL_PROFESSIONAL' or 'MEDICAL_ANALYSIS_LABORATORY' or 'GENERAL_HEALTH_CARE_SYSTEM' or
'MSA_HEALTH_CARE_SYSTEM' or 'MSI_HEALTH_CARE_SYSTEM' or 'OTHER_HEALTH_CARE_SYSTEM' or 'MUTUAL_HEALTH' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">item_type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"MEDICAL_PROFESSIONAL", "MEDICAL_ANALYSIS_LABORATORY", "GENERAL_HEALTH_CARE_SYSTEM", "MSA_HEALTH_CARE_SYSTEM", "MSI_HEALTH_CARE_SYSTEM", "OTHER_HEALTH_CARE_SYSTEM", "MUTUAL_HEALTH", "OTHER"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">civility</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">pro_type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">web_site</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">mail</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">phone_number</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">appointment_link</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">regular_doctor</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">photo</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">item_type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>the name is required</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknown user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">health_id</td>
<td>
<input class="parameter required" minlength="1" name="health_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the health item</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="document_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdInput {</span>
<div><span class="propName false">document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Document added.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document is already in this health item.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_input</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="housing_input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The housing input data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HousingInput {</span>
<div><span class="propName false">sub_locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">street_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">post_office_box</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extended_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">label</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">housing_type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">sub_locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">street_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">post_office_box</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extended_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">label</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">housing_type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Not a valid Housing input.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document isn't in this house.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not user's document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow House ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No picture for this House</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">picture</td>
<td>
<input type="file" name="picture">
</td>
<td>
<strong><span class="markdown">
<p>The picture to upload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No picture for this House</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">procedure_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="procedure_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a procedure in the safe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserProcedureIdInput {</span>
<div><span class="propName false">user_procedure_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Procedure added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Procedure doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The procedure is already in this house.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a procedure in the safe</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Procedure isn't in this house.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not user's procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Housing not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">housing_input</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="housing_input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The housing input data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">HousingInput {</span>
<div><span class="propName false">sub_locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">street_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">post_office_box</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extended_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">label</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">housing_type</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">sub_locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">street_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">post_office_box</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extended_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">label</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">housing_type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Not a valid Housing input.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Housing ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Housing ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">since_id</td>
<td>
<input class="parameter" minlength="0" name="since_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created after the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">max_id</td>
<td>
<input class="parameter" minlength="0" name="max_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created before the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The type of the returned items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">status</td>
<td>
<select class="parameter" name="status">
<option selected="" value=""></option>
<option value="ARCHIVED">ARCHIVED</option>
<option value="NOT_ARCHIVED">NOT_ARCHIVED</option>
</select>
</td>
<td class="markdown">
<p>the object current status</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">housing_id</td>
<td>
<input class="parameter required" minlength="1" name="housing_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The ID of the housing</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="document_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdInput {</span>
<div><span class="propName false">document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Document added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document is already in this house.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">registration_id</td>
<td>
<input class="parameter required" minlength="1" name="registration_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>registration id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">fieldValue1</td>
<td>
<input class="parameter" minlength="0" name="fieldValue1" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>identification security+ field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">fieldValue2</td>
<td>
<input class="parameter" minlength="0" name="fieldValue2" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>authentication security+ field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Registration not match with security form</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Registration not found with this id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>registration already used or canceld</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">senderPid</td>
<td>
<input class="parameter required" minlength="1" name="senderPid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the sender pid</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">fieldValue1</td>
<td>
<input class="parameter required" minlength="1" name="fieldValue1" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>identification security+ field</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">fieldValue2</td>
<td>
<input class="parameter" minlength="0" name="fieldValue2" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>authentication security+ field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>registration not found for this sender and this securityForm</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Registration already used or canceled</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">registration_id</td>
<td>
<input class="parameter required" minlength="1" name="registration_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant de la pré-inscription</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>email</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MailInput {</span>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Registration not found with this id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Registration already used or canceled</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">fieldOne</td>
<td> (empty) </td>
<td class="markdown">
<p>fieldOne</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">senderCode</td>
<td> (empty) </td>
<td class="markdown">
<p>senderCode</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">registrationId</td>
<td> (empty) </td>
<td class="markdown">
<p>registrationId</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document isn't in this job.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Not user document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Job ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No avatar in this Employer</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">picture</td>
<td>
<input type="file" name="picture">
</td>
<td>
<strong><span class="markdown">
<p>The picture to upload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>No picture for this employer</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Fail</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="employer_data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data of the Employer</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">EmployerDataInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">begin_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">end_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">position</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">current_position</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">type</span> (<span class="propType">string</span>) = <span class="propVals">['PROFESSION' or 'APPRENTICESHIP' or 'RETIREMENT' or 'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP'
or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING", "VOLUNTEER", "INTERNSHIP", "OTHER"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">begin_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">position</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">current_position</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The end date must be after the begin date</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="user_procedure_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserProcedureIdInput {</span>
<div><span class="propName false">user_procedure_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Procedure added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's user procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>User procedure doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The user procedure is already in this Job.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The id of a user procedure</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted with success</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's user procedure.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>User procedure isn't in this Job.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Employer ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">employer_data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="employer_data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The data of the Employer</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">EmployerDataInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">begin_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">end_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">position</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">current_position</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">type</span> (<span class="propType">string</span>) = <span class="propVals">['PROFESSION' or 'APPRENTICESHIP' or 'RETIREMENT' or 'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP'
or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING", "VOLUNTEER", "INTERNSHIP", "OTHER"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">begin_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">position</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">current_position</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Not a valid Employer input.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Employer ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow Employer ID.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknow ID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">employer_id</td>
<td>
<input class="parameter required" minlength="1" name="employer_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>the id of the employer</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="document_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The id of a document in the safe</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentIdInput {</span>
<div><span class="propName false">document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Document added</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Not user's document.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Document doesn't exist.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document is already in this Job.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Unknow user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">hash</td>
<td>
<textarea class="body-textarea" name="hash"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash value of the document content</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">algo</td>
<td>
<textarea class="body-textarea" name="algo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash algorithm to check the hash</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">folder_id</td>
<td>
<textarea class="body-textarea" name="folder_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Folder ID where the document will be stored</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code">X-AuthorizeSender</td>
<td>
<select class="parameter" name="X-AuthorizeSender">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>header</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code required">archive</td>
<td>
<input type="file" name="archive">
</td>
<td>
<strong><span class="markdown">
<p>The file to archive</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document hash is wrong</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The document to upload is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">documentId</td>
<td>
<input class="parameter required" minlength="1" name="documentId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad request</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The requested legator does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">sender_pid</td>
<td>
<input class="parameter required" minlength="1" name="sender_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Sender pid</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">field_one</td>
<td>
<input class="parameter required" minlength="1" name="field_one" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Field one</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">sender_pid</td>
<td>
<input class="parameter required" minlength="1" name="sender_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Sender pid</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">Array[string]</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MembershipOptoutInput {</span>
<div><span class="propWrap"><span class="propName true">partner_user_id</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">partner_user_id</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[-_\.\sa-zA-Z0-9]{1,255}</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">secret_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">secret_code</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[-_a-zA-Z0-9]{1,255}</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">firstname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">firstname</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">lastname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">lastname</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">send_mail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">firstname</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">lastname</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">send_mail</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MembershipOptinInput {</span>
<div><span class="propWrap"><span class="propName true">partner_user_id</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">partner_user_id</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[-_a-zA-Z0-9]{1,255}</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">secret_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">secret_code</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[-_a-zA-Z0-9]{1,255}</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">firstname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">firstname</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">lastname</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">lastname</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">send_mail</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">firstname</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">lastname</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">send_mail</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MembershipInput {</span>
<div><span class="propName false">address</span> (<span class="propType">MembershipAddress</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">field1_value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">field2_value</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">sender_pid</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">folder_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">MembershipAddress {</span>
<div><span class="propName false">sub_locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">street_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">post_office_box</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extended_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">address</span>": <span class="value">{
"<span class="attribute">sub_locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">street_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">post_office_box</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extended_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country_code</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">field1_value</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">field2_value</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">sender_pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">folder_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">registrationId</td>
<td>
<input class="parameter" minlength="0" name="registrationId" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">input</td>
<td>
<input class="parameter required" minlength="1" name="input" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Incorrect parameter</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The membership isn't available</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">partner_id</td>
<td>
<input class="parameter" minlength="0" name="partner_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>PartnerId (senderCode)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">partner_user_id</td>
<td>
<input class="parameter" minlength="0" name="partner_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>UserId from partner (fieldone)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>All parameters are required</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Partner not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of membership</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">value</td>
<td>
<input class="parameter" minlength="0" name="value" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Folder ID</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of membership</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">alias</td>
<td>
<textarea class="body-textarea" name="alias"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Alias of membership</p>
</td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MembershipAliasInput {</span>
<div><span class="propName false">alias</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">alias</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The alias is not valid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Membership Id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">note</td>
<td>
<textarea class="body-textarea" name="note"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Membership note</p>
</td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MembershipNoteInput {</span>
<div><span class="propName false">note</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">note</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Note is not valid (empty or more than 500 characters)</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of membership</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Membership doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of membership</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>Can delete collected membership only if sender allow it</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of membership</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Membership doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Membership is not collected membership</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">410</td>
<td>TransactionId expired</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td>unknown transaction state</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id</td>
<td>
<input class="parameter required" minlength="1" name="id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of membership</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad membership statusLabel.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Membership doesn't exist or not accesible.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">MembershipIdsInput {</span>
<div><span class="propName false">ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Incorrect parameter</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">501</td>
<td>unknown transaction state</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">503</td>
<td>service unavailable</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">status</td>
<td>
<input class="parameter" minlength="0" name="status" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>the object current status</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">partner_id</td>
<td>
<input class="parameter required" minlength="1" name="partner_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>PartnerId (senderCode)</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">status_label</td>
<td>
<input class="parameter" minlength="0" name="status_label" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>the object current status</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">min_updated_at</td>
<td>
<input class="parameter" minlength="0" name="min_updated_at" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The minimum date of last update</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">max_updated_at</td>
<td>
<input class="parameter" minlength="0" name="max_updated_at" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum date of last update</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">route_code</td>
<td>
<input class="parameter" minlength="0" name="route_code" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>route code</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">partner_user_id</td>
<td>
<input class="parameter" minlength="0" name="partner_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>UserId from partner (fieldone)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>min_updated_at can't be after min_updated_at</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Sender not found with partner_id =</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">partner_id</td>
<td>
<input class="parameter" minlength="0" name="partner_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>PartnerId (senderCode)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">partner_user_id</td>
<td>
<input class="parameter" minlength="0" name="partner_user_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>UserId from partner (fieldone)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Functional object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">notification_id</td>
<td>
<input class="parameter required" minlength="1" name="notification_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of user notification</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>new notification data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">NotificationInput {</span>
<div><span class="propName true">read</span> (<span class="propType">boolean</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">read</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The type of the returned items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">read</td>
<td>
<select class="parameter" name="read">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>To filter by read status</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">pid</td>
<td>
<input class="parameter required" minlength="1" name="pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>unknow onboarding pid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>You are trying to get the current user but there is no current user related to this request!</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>json generation failed</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">input</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the onboarding pid</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">OnboardingDTO {</span>
<div><span class="propName true">onboarding_pid</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">onboarding_pid</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>onboarding pid may not be null</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>You are trying to get the current user but there is no current user related to this request!</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>json generation failed</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>You are trying to get the current user but there is no current user related to this request!</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
<tr>
<td class="code required">title</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The title of the document.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">file_name</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="file_name"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The name of the document.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">archive_duration</td>
<td>
<textarea class="body-textarea" name="archive_duration"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The end date of legal archiving.</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code required">author_tags</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="author_tags"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The sender tags. Separated by '|' or ','.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">hash</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="hash"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The hash value of the document content.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">algo</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="algo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The hash algorithm to check the hash.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">file_size</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="file_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Size of the file.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">archive</td>
<td>
<input type="file" name="archive">
</td>
<td>
<strong><span class="markdown">
<p>archive</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document to upload is empty</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The document to upload is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">client_id</td>
<td>
<input class="parameter required" minlength="1" name="client_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>client id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Données en entrée incorrectes</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">client_id</td>
<td>
<input class="parameter required" minlength="1" name="client_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>client id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>update partner</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PartnerInput {</span>
<div><span class="propName true">partner</span> (<span class="propType">PartnerDto</span>),</div>
<div><span class="propName true">oauth</span> (<span class="propType">PartnerOauthDto</span>)</div><span class="strong">}</span><br><span class="strong">PartnerDto {</span>
<div><span class="propWrap"><span class="propName true">application</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">application</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[[\p{L}][\p{M}][\p{N}]_\- ]+</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName true">description</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">authorization_description</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">logo_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PartnerOauthDto {</span>
<div><span class="propName true">callback_urls</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">enabled</span> (<span class="propType">boolean</span>),</div>
<div><span class="propName false">refresh_token_validity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">access_token_validity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">workflows</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">partner</span>": <span class="value">{
"<span class="attribute">application</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">authorization_description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">logo_url</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">oauth</span>": <span class="value">{
"<span class="attribute">callback_urls</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">enabled</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">refresh_token_validity</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">access_token_validity</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">workflows</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Données en entrée incorrectes</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add partner</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PartnerInput {</span>
<div><span class="propName true">partner</span> (<span class="propType">PartnerDto</span>),</div>
<div><span class="propName true">oauth</span> (<span class="propType">PartnerOauthDto</span>)</div><span class="strong">}</span><br><span class="strong">PartnerDto {</span>
<div><span class="propWrap"><span class="propName true">application</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">application</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[[\p{L}][\p{M}][\p{N}]_\- ]+</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName true">description</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">authorization_description</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">logo_url</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PartnerOauthDto {</span>
<div><span class="propName true">callback_urls</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">enabled</span> (<span class="propType">boolean</span>),</div>
<div><span class="propName false">refresh_token_validity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">access_token_validity</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">workflows</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">partner</span>": <span class="value">{
"<span class="attribute">application</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">authorization_description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">logo_url</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">oauth</span>": <span class="value">{
"<span class="attribute">callback_urls</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">enabled</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">refresh_token_validity</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">access_token_validity</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">workflows</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Données en entrée incorrectes</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">client_id</td>
<td>
<input class="parameter required" minlength="1" name="client_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>client id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>update partner rights</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PartnerApiAccessInput {</span>
<div><span class="propName true">api_access</span> (<span class="propType">Array[ApiAccessDto]</span>)</div><span class="strong">}</span><br><span class="strong">ApiAccessDto {</span>
<div><span class="propName true">http_method</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">resource</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">operation</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">api_access</span>": <span class="value">[
{
"<span class="attribute">http_method</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">resource</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">operation</span>": <span class="value"><span class="string">"string"</span>
}</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Le partenaire n'existe pas</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td>La ressource demandée (verbe HTTP + ressource API) n'existe pas</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">client_id</td>
<td>
<input class="parameter required" minlength="1" name="client_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>client id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Le partenaire n'existe pas</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Partner offer</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ChangeOfferInput {</span>
<div><span class="propName false">partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">platform</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">to_product_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">platform</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">to_product_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>The offer has been changed</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Wrong or missing mandatory parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknown partner_user_id, platform and/or product_id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Partner offer</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CancelPartnerOfferInput {</span>
<div><span class="propName false">partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">platform</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">product_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">platform</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">product_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>The offer has been canceled</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Wrong or missing mandatory parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Unknown partner_user_id, platform and/or product_id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>document id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">qualify_procedure_input</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="qualify_procedure_input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>qualification parameters</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">QualifyProcedureInput {</span>
<div><span class="propWrap"><span class="propName true">status</span> (<span class="propType">string</span>) = <span class="propVals">['STARTED' or 'REQUESTED' or 'VALIDATED' or 'COMPLETED' or 'OBSOLETED']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">status</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propName false">refusal_ground</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">refused_documents</span> (<span class="propType">Array[RefusedDocument]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">RefusedDocument {</span>
<div><span class="propName false">document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">refusal_ground</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">status</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">refusal_ground</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">refused_documents</span>": <span class="value">[
{
"<span class="attribute">document_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">refusal_ground</span>": <span class="value"><span class="string">"string"</span>
}</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">document_id</td>
<td>
<input class="parameter required" minlength="1" name="document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>document id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">procedure_pid</td>
<td>
<input class="parameter required" minlength="1" name="procedure_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>procedure pid</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">X-OrganismUserId</td>
<td>
<input class="parameter" minlength="0" name="X-OrganismUserId" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">X-OrganismId</td>
<td>
<input class="parameter" minlength="0" name="X-OrganismId" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>header</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">procedure_pid</td>
<td>
<input class="parameter required" minlength="1" name="procedure_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">procedure_pid</td>
<td>
<input class="parameter required" minlength="1" name="procedure_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>procedure pid</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">status</td>
<td>
<select class="parameter" name="status">
<option selected="" value=""></option>
<option value="STARTED">STARTED</option>
<option value="REQUESTED">REQUESTED</option>
<option value="VALIDATED">VALIDATED</option>
<option value="COMPLETED">COMPLETED</option>
<option value="OBSOLETED">OBSOLETED</option>
</select>
</td>
<td class="markdown">
<p>procedure status</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>maximum number of procedures to retrieve</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>page index</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">offset</td>
<td>
<input class="parameter" minlength="0" name="offset" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>specify which row should be fetched first.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">limit</td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>limit the records returned.</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">procedure_pid</td>
<td>
<input class="parameter required" minlength="1" name="procedure_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>procedure pid</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid parameter, procedure not found for the given PID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Access denied for the given procedure PID</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Reminders not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Internal error</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Title and date of reminder that will be created</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ReminderInput {</span>
<div><span class="propName true">title</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">date</span> (<span class="propType">date-time</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.470Z"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Title or date are invalids</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>user procedure not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Internal error</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the updated procedure model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SpecificProcedureInput {</span>
<div><span class="propName false">modification_reason</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">assets</span> (<span class="propType">Array[RequiredDocumentNature]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">RequiredDocumentNature {</span>
<div><span class="propWrap"><span class="propName true">type</span> (<span class="propType">string</span>) = <span class="propVals">['CATEGORY' or 'NATURE' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"CATEGORY", "NATURE", "OTHER"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName false">pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">pid</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[A-Z0-9_]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">count</span> (<span class="propType">integer</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">count</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">modification_reason</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">assets</span>": <span class="value">[
{
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">count</span>": <span class="value"><span class="number">0</span>
}</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">membership_id</td>
<td>
<input class="parameter required" minlength="1" name="membership_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>membership_id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Membership doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the procedure model</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">SpecificProcedureInput {</span>
<div><span class="propName false">modification_reason</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">assets</span> (<span class="propType">Array[RequiredDocumentNature]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">RequiredDocumentNature {</span>
<div><span class="propWrap"><span class="propName true">type</span> (<span class="propType">string</span>) = <span class="propVals">['CATEGORY' or 'NATURE' or 'OTHER']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">type</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"CATEGORY", "NATURE", "OTHER"</td>
</tr>
</tbody>
</table>
</span>,</div>
<div><span class="propWrap"><span class="propName false">pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">pid</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[A-Z0-9_]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">count</span> (<span class="propType">integer</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">count</th>
</tr>
<tr>
<td class="optionName">Min. Value:</td>
<td>1</td>
</tr>
<tr>
<td class="optionName">Max. Value:</td>
<td>100</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">modification_reason</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">assets</span>": <span class="value">[
{
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">count</span>": <span class="value"><span class="number">0</span>
}</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">title</td>
<td>
<textarea class="body-textarea" name="title"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The title of the document</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">hash</td>
<td>
<textarea class="body-textarea" name="hash"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash value of the document content</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">algo</td>
<td>
<textarea class="body-textarea" name="algo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The hash algorithm to check the hash</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">archive_size</td>
<td>
<textarea class="body-textarea" name="archive_size"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Size of the archive</p>
</td>
<td>body</td>
<td>
<span class="model-signature">long</span>
</td>
</tr>
<tr>
<td class="code required">archive</td>
<td>
<input type="file" name="archive">
</td>
<td>
<strong><span class="markdown">
<p>The file to archive</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">File</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The archive size is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The document hash is wrong</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">413</td>
<td>The document to upload is too large</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add document to user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureDocumentInput {</span>
<div><span class="propName false">user_procedure_document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_group</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">add_to_latest_group</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">procedure_only</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_document_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">document_group</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">add_to_latest_group</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">procedure_only</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>user procedure document id</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureDocumentInput {</span>
<div><span class="propName false">user_procedure_document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_group</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">add_to_latest_group</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">procedure_only</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_document_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">document_group</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">add_to_latest_group</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">procedure_only</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The share data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureShareDataInput {</span>
<div><span class="propName false">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">start_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName true">end_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName false">recipient_mails</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">security_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">share_date_range_under_one_year</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">start_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.470Z"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.470Z"</span></span>,
"<span class="attribute">recipient_mails</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">security_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">share_date_range_under_one_year</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The share data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureShareDataInput {</span>
<div><span class="propName false">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">start_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName true">end_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName false">recipient_mails</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">security_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">share_date_range_under_one_year</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">start_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.470Z"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.470Z"</span></span>,
"<span class="attribute">recipient_mails</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">security_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">share_date_range_under_one_year</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add document to user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureDocumentInput {</span>
<div><span class="propName false">user_procedure_document_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">nature_pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_group</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">add_to_latest_group</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">procedure_only</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">user_procedure_document_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">nature_pid</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">document_group</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">add_to_latest_group</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">procedure_only</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>new status of the user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureStatusInput {</span>
<div><span class="propWrap"><span class="propName false">status</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>) = <span class="propVals">['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">status</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">status</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid request parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid request parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_procedure_id</td>
<td>
<input class="parameter required" minlength="1" name="user_procedure_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user procedure id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Rename user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Can't rename user procedure</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">procedure_pid</td>
<td>
<input class="parameter required" minlength="1" name="procedure_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>procedure pid</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add user procedure</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProcedureInput {</span>
<div><span class="propName false">name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">name</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">mode</td>
<td>
<input class="parameter" minlength="0" name="mode" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The selected profile view mode, default is simple</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>The user birthdate and title</p>
</td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProfileIdentityData {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">birth_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">given_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">given_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">family_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">family_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">birth_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">birth_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">birth_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">given_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">family_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">birth_name</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">address_id</td>
<td>
<input class="parameter required" minlength="1" name="address_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The address ID to get</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>the address id doesn't exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>index of page , used for pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>max_results is used to limit number of item returned by API</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>index or maxResults are invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Phone Number that will be created</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PhoneNumberInput {</span>
<div><span class="propName true">phone_number</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">type</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">label</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">phone_number</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">label</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">500</td>
<td>Phone number ID is missing</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">phone_number_id</td>
<td>
<input class="parameter required" minlength="1" name="phone_number_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of phone Number</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Phone number ID is missing</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>ID of phone Number that will be edited</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PhoneNumberInput {</span>
<div><span class="propName true">phone_number</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">type</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">label</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">phone_number</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">label</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code required">phone_number_id</td>
<td>
<input class="parameter required" minlength="1" name="phone_number_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Phone number already exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Phone number ID is missing</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">phone_number_id</td>
<td>
<input class="parameter required" minlength="1" name="phone_number_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of phone Number that will be deleted</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Phone number ID is missing</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">notExpired</td>
<td>
<select class="parameter" name="notExpired">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p> return only not expired authorized applications</p>
</td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>No access token found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserOfferInput {</span>
<div><span class="propName false">purchase_transaction</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">platform</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">order_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">product_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">purchase_transaction</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">platform</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">order_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">product_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Offer doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Purchase transaction already exists</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">undefined</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">LocaleInput {</span>
<div><span class="propWrap"><span class="propName true">locale</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">locale</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-z]{2}_[A-Z]{2}|[a-z]{2}$</td>
</tr>
</tbody>
</table></span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">locale</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">token_dgp</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="token_dgp"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>the token generated by digiposte.</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CcuTokenInput {</span>
<div><span class="propName false">token_ccu</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">token_ccu</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td>Accounts linked.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Missing mandatory argument</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>CCU user not found.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>User part cannot be linked to User pro.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">index</td>
<td>
<input class="parameter required" minlength="1" name="index" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Page index.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
<tr>
<td class="code required">max_results</td>
<td>
<input class="parameter required" minlength="1" name="max_results" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Page size.</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">integer</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid or missing pagination parameters.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>No access token found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Executed action</p>
</td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserActionHelpList {</span>
<div><span class="propName false">actions</span> (<span class="propType">object</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">actions</span>": <span class="value">{}
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>remove documents to user profile </p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProfileDocumentsNaturePidInput {</span>
<div><span class="propName false">entries</span> (<span class="propType">Array[ProfileDocumentNaturePidEntry]</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span
class="strong">ProfileDocumentNaturePidEntry {</span>
<div><span class="propName false">profile_document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">nature_pid</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">entries</span>": <span class="value">[
{
"<span class="attribute">profile_document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">nature_pid</span>": <span class="value"><span class="string">"string"</span>
}</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add document to user profile </p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProfileDocumentsNaturePidData {</span>
<div><span class="propName true">document_ids</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">document_nature_pid</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">document_nature_pid</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_profile_document_id</td>
<td>
<input class="parameter required" minlength="1" name="user_profile_document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user profile document id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add document to user profile </p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ProfileDocumentsInputData {</span>
<div><span class="propName true">document_ids</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">document_nature_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">document_nature_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_profile_document_id</td>
<td>
<input class="parameter required" minlength="1" name="user_profile_document_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>user profile document id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>Access to resource forbidden</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Domain object not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">nature_pid</td>
<td>
<input class="parameter required" minlength="1" name="nature_pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">notification_type</td>
<td>
<input class="parameter required" minlength="1" name="notification_type" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">body</td>
<td>
<textarea class="body-textarea" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown"></td>
<td>body</td>
<td>
<span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">NotificationPreferenceInput {</span>
<div><span class="propName true">enable</span> (<span class="propType">boolean</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">enable</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">reminder_id</td>
<td>
<input class="parameter required" minlength="1" name="reminder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of reminder that will be returned</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>Reminder Not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">reminder_id</td>
<td>
<input class="parameter required" minlength="1" name="reminder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of reminder that will be updated</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">reminder_input</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="reminder_input"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>ID of reminder that will be updated</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">ReminderInput {</span>
<div><span class="propName true">title</span> (<span class="propType">string</span>),</div>
<div><span class="propName true">date</span> (<span class="propType">date-time</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.471Z"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>title is too long or date is invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Reminder Not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">reminder_id</td>
<td>
<input class="parameter required" minlength="1" name="reminder_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>ID of reminder that will be deleted</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>the reminder was deleted</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Reminder Not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">until</td>
<td>
<input class="parameter" minlength="0" name="until" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Until date (format :yyyyMMdd)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">limit</td>
<td>
<input class="parameter" minlength="0" name="limit" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Results limit (greater than 0)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>One or more parameters are invalid</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">id_lot</td>
<td>
<input class="parameter required" minlength="1" name="id_lot" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>lot id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="ATS">
</td>
<td class="markdown">
<p>type</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">integrity</td>
<td>
<input class="parameter" minlength="0" name="integrity" placeholder="" type="text" value="FALSE">
</td>
<td class="markdown">
<p>integrity</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Format incorrect : Integrity</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Le gestionnaire n'est pas autorisé à utiliser cet api pour cet émetteur</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Cannot found the sender with pid '{senderPid}'</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">500</td>
<td>Encountered an internal error.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">partnerId</td>
<td>
<input class="parameter required" minlength="1" name="partnerId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The sender pid to clone</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">legal_name</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="legal_name"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Legal name</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">clone_partner_id</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="clone_partner_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>clone_partner_id</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">siren_siret</td>
<td>
<textarea class="body-textarea" name="siren_siret"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Siren/Siret</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">vat_number</td>
<td>
<textarea class="body-textarea" name="vat_number"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>vat_number</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">street</td>
<td>
<textarea class="body-textarea" name="street"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>street</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">zip_code</td>
<td>
<textarea class="body-textarea" name="zip_code"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>zipCode</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">locality</td>
<td>
<textarea class="body-textarea" name="locality"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>locality</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">selfcare_url_fr</td>
<td>
<textarea class="body-textarea" name="selfcare_url_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>selfcare_url_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label1_fr</td>
<td>
<textarea class="body-textarea" name="label1_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>label1_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label2_fr</td>
<td>
<textarea class="body-textarea" name="label2_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>label2_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field2_encoding</td>
<td>
<textarea class="body-textarea" name="field2_encoding"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>field2_encoding</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">documents_naming_fr</td>
<td>
<textarea class="body-textarea" name="documents_naming_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>documents_naming_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">security_redirect</td>
<td>
<select class="parameter" name="security_redirect">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>security_redirect</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">special_offer</td>
<td>
<textarea class="body-textarea" name="special_offer"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>special_offer</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">thumbnail</td>
<td>
<textarea class="body-textarea" name="thumbnail"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>thumbnail</p>
</td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
<tr>
<td class="code">logo</td>
<td>
<textarea class="body-textarea" name="logo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>logo</p>
</td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
<tr>
<td class="code">presentation_fr</td>
<td>
<textarea class="body-textarea" name="presentation_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>presentation_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">more_info_fr</td>
<td>
<textarea class="body-textarea" name="more_info_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>more_info_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">publisher_partner_id</td>
<td>
<textarea class="body-textarea" name="publisher_partner_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>publisher_partner_id</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip1_fr</td>
<td>
<textarea class="body-textarea" name="tooltip1_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>tooltip1_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip2_fr</td>
<td>
<textarea class="body-textarea" name="tooltip2_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>tooltip2_fr</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field1_example</td>
<td>
<textarea class="body-textarea" name="field1_example"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>field1_example</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field2_example</td>
<td>
<textarea class="body-textarea" name="field2_example"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>field2_example</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label1_en</td>
<td>
<textarea class="body-textarea" name="label1_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 1 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip1_en</td>
<td>
<textarea class="body-textarea" name="tooltip1_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 1 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label2_en</td>
<td>
<textarea class="body-textarea" name="label2_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 2 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip2_en</td>
<td>
<textarea class="body-textarea" name="tooltip2_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 2 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">presentation_en</td>
<td>
<textarea class="body-textarea" name="presentation_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Presentation in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">more_info_en</td>
<td>
<textarea class="body-textarea" name="more_info_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>More info in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">selfcare_url_en</td>
<td>
<textarea class="body-textarea" name="selfcare_url_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>English organisation url</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">document_naming_en</td>
<td>
<textarea class="body-textarea" name="document_naming_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Documents naming in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">alias</td>
<td>
<textarea class="body-textarea" name="alias"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="multipart/form-data">multipart/form-data</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>List of aliases, comma seperated</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>no sender found with this id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">pid</td>
<td>
<input class="parameter required" minlength="1" name="pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The sender pid</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">pid</td>
<td>
<input class="parameter required" minlength="1" name="pid" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The sender pid</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">label1_fr</td>
<td>
<textarea class="body-textarea" name="label1_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 1 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label1_en</td>
<td>
<textarea class="body-textarea" name="label1_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 1 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip1_fr</td>
<td>
<textarea class="body-textarea" name="tooltip1_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 1 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip1_en</td>
<td>
<textarea class="body-textarea" name="tooltip1_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 1 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label2_fr</td>
<td>
<textarea class="body-textarea" name="label2_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 2 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label2_en</td>
<td>
<textarea class="body-textarea" name="label2_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 2 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip2_fr</td>
<td>
<textarea class="body-textarea" name="tooltip2_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 2 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip2_en</td>
<td>
<textarea class="body-textarea" name="tooltip2_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 2 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">presentation_fr</td>
<td>
<textarea class="body-textarea" name="presentation_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Presentation in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">presentation_en</td>
<td>
<textarea class="body-textarea" name="presentation_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Presentation in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">more_info_fr</td>
<td>
<textarea class="body-textarea" name="more_info_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>More info in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">more_info_en</td>
<td>
<textarea class="body-textarea" name="more_info_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>More info in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field1_example</td>
<td>
<textarea class="body-textarea" name="field1_example"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Field1 example</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field2_example</td>
<td>
<textarea class="body-textarea" name="field2_example"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Field2 example</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">selfcare_url_fr</td>
<td>
<textarea class="body-textarea" name="selfcare_url_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>French organisation url</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">selfcare_url_en</td>
<td>
<textarea class="body-textarea" name="selfcare_url_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>English organisation url</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">routing_emails</td>
<td>
<textarea class="body-textarea" name="routing_emails"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Routing emails list comma separated</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">aliases</td>
<td>
<textarea class="body-textarea" name="aliases"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Alias list comma separated</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">street</td>
<td>
<textarea class="body-textarea" name="street"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Street part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">country</td>
<td>
<textarea class="body-textarea" name="country"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Country part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">locality</td>
<td>
<textarea class="body-textarea" name="locality"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Locality part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">zip_code</td>
<td>
<textarea class="body-textarea" name="zip_code"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Zipcode part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">siren_siret</td>
<td>
<textarea class="body-textarea" name="siren_siret"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Siren/Siret</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">vat_number</td>
<td>
<textarea class="body-textarea" name="vat_number"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Vat number</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">legal_name</td>
<td>
<textarea class="body-textarea" name="legal_name"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Legal name</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">thumbnail</td>
<td>
<textarea class="body-textarea" name="thumbnail"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Thumbnail image</p>
</td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
<tr>
<td class="code">logo</td>
<td>
<textarea class="body-textarea" name="logo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Logo image</p>
</td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">pid</td>
<td>
<textarea class="body-textarea" name="pid"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Pid</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">legal_name</td>
<td>
<textarea class="body-textarea" name="legal_name"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Legal name</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">siren_siret</td>
<td>
<textarea class="body-textarea" name="siren_siret"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Siren/Siret</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">vat_number</td>
<td>
<textarea class="body-textarea" name="vat_number"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Vat number</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<textarea class="body-textarea" name="type"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Type</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">visible</td>
<td>
<select class="parameter" name="visible">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Visibile</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">findable</td>
<td>
<select class="parameter" name="findable">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Findable</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">security_redirect</td>
<td>
<select class="parameter" name="security_redirect">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Security redirect</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">multi_subscription</td>
<td>
<select class="parameter" name="multi_subscription">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Multi subscription</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">multilingual</td>
<td>
<select class="parameter" name="multilingual">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Multilingual</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">hr</td>
<td>
<select class="parameter" name="hr">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>HR</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">health</td>
<td>
<select class="parameter" name="health">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Health</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">first_notification_type</td>
<td>
<textarea class="body-textarea" name="first_notification_type"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>First notification type</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">number_of_personalization_email_reminders</td>
<td>
<textarea class="body-textarea" name="number_of_personalization_email_reminders"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Number of personalization email reminders</p>
</td>
<td>body</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">self_cancellation</td>
<td>
<select class="parameter" name="self_cancellation">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Self cancellation</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">self_cancellation_timeout</td>
<td>
<textarea class="body-textarea" name="self_cancellation_timeout"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Self cancellation timeout</p>
</td>
<td>body</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">alias_allowed</td>
<td>
<select class="parameter" name="alias_allowed">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Alias allowed</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">notification_type</td>
<td>
<textarea class="body-textarea" name="notification_type"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Notification type</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label1_fr</td>
<td>
<textarea class="body-textarea" name="label1_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 1 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label1_en</td>
<td>
<textarea class="body-textarea" name="label1_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 1 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip1_fr</td>
<td>
<textarea class="body-textarea" name="tooltip1_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 1 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip1_en</td>
<td>
<textarea class="body-textarea" name="tooltip1_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 1 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label2_fr</td>
<td>
<textarea class="body-textarea" name="label2_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 2 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">label2_en</td>
<td>
<textarea class="body-textarea" name="label2_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Label 2 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip2_fr</td>
<td>
<textarea class="body-textarea" name="tooltip2_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 2 in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tooltip2_en</td>
<td>
<textarea class="body-textarea" name="tooltip2_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Tooltip 2 in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">presentation_fr</td>
<td>
<textarea class="body-textarea" name="presentation_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Presentation in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">presentation_en</td>
<td>
<textarea class="body-textarea" name="presentation_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Presentation in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">more_info_fr</td>
<td>
<textarea class="body-textarea" name="more_info_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>More info in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">more_info_en</td>
<td>
<textarea class="body-textarea" name="more_info_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>More info in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">documents_naming_fr</td>
<td>
<textarea class="body-textarea" name="documents_naming_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Documents naming in french</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">documents_naming_en</td>
<td>
<textarea class="body-textarea" name="documents_naming_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Documents naming in english</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field1_example</td>
<td>
<textarea class="body-textarea" name="field1_example"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Field1 example</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">field2_example</td>
<td>
<textarea class="body-textarea" name="field2_example"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Field2 example</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">selfcare_url_fr</td>
<td>
<textarea class="body-textarea" name="selfcare_url_fr"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>French organisation url</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">selfcare_url_en</td>
<td>
<textarea class="body-textarea" name="selfcare_url_en"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>English organisation url</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">routing_emails</td>
<td>
<textarea class="body-textarea" name="routing_emails"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Routing emails list comma separated</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">aliases</td>
<td>
<textarea class="body-textarea" name="aliases"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Alias list comma separated</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">street</td>
<td>
<textarea class="body-textarea" name="street"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Street part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">country</td>
<td>
<textarea class="body-textarea" name="country"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Country part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">locality</td>
<td>
<textarea class="body-textarea" name="locality"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Locality part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">zip_code</td>
<td>
<textarea class="body-textarea" name="zip_code"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Zipcode part of the address</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">thumbnail</td>
<td>
<textarea class="body-textarea" name="thumbnail"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Thumbnail image</p>
</td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
<tr>
<td class="code">logo</td>
<td>
<textarea class="body-textarea" name="logo"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Logo image</p>
</td>
<td>body</td>
<td>
<span class="model-signature">Attachment</span>
</td>
</tr>
<tr>
<td class="code">dematerialized_sender_side</td>
<td>
<select class="parameter" name="dematerialized_sender_side">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown">
<p>Dematerialized agreement sender side</p>
</td>
<td>body</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">dematerialized_agreement_url</td>
<td>
<textarea class="body-textarea" name="dematerialized_agreement_url"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Dematerialized agreement url</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">category</td>
<td>
<textarea class="body-textarea" name="category"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Category</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">publisher_partner_id</td>
<td>
<textarea class="body-textarea" name="publisher_partner_id"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td class="markdown">
<p>Parent publisher pid</p>
</td>
<td>body</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">share_id</td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du partage à retourner</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>The share does not belong to the authenticated user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The share does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">share_id</td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du partage à updater</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The share data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentShareDataInput {</span>
<div><span class="propName false">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">start_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName true">end_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName false">recipient_mails</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">security_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">share_date_range_under_one_year</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">start_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.471Z"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.471Z"</span></span>,
"<span class="attribute">recipient_mails</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">security_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">share_date_range_under_one_year</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The share data provided tries to update the resource id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>The share to update does not belong to the authenticated user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The share to update does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">share_id</td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du partage à retourner</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>The share does not belong to the authenticated user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The share does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">share_id</td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du partage à retourner</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>The share does not belong to the authenticated user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The share does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">share_id</td>
<td>
<input class="parameter required" minlength="1" name="share_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Identifiant du partage</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Les ids des documents à mettre dans le partage</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">IdSet {</span>
<div><span class="propName true">ids</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">403</td>
<td>One of the documents does not belong to the authenticated user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>One of the documents does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The share data</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentShareDataInput {</span>
<div><span class="propName false">description</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">start_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName true">end_date</span> (<span class="propType">date-time</span>),</div>
<div><span class="propName false">recipient_mails</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">security_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">share_date_range_under_one_year</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">description</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">start_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.471Z"</span></span>,
"<span class="attribute">end_date</span>": <span class="value"><span class="string">"2024-09-23T11:00:41.471Z"</span></span>,
"<span class="attribute">recipient_mails</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">security_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">share_date_range_under_one_year</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The share data can't provide an id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>DOCUMENT or PROCEDURE, missing or unknown value return ALL</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>DOCUMENT or PROCEDURE, missing or unknown value return ALL</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>The share space of the currently connected user is not active</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">signatureId</td>
<td>
<input class="parameter required" minlength="1" name="signatureId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">userAction</td>
<td>
<input class="parameter" minlength="0" name="userAction" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">signatureId</td>
<td>
<input class="parameter required" minlength="1" name="signatureId" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">doneUrl</td>
<td>
<input class="parameter" minlength="0" name="doneUrl" placeholder="" type="text" value="">
</td>
<td class="markdown"></td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Bad pagination values provided</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">nature_id</td>
<td>
<input class="parameter required" minlength="1" name="nature_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>nature id</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The nature doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>request body containing nature and documents ids</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">DocumentNatureInput {</span>
<div><span class="propName false">nature_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">document_ids</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">nature_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">document_ids</span>": <span class="value">[
<span class="string">"string"</span>
]
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Documents natures successfully updated</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>The document or nature doesn't exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">430</td>
<td>Part of document list not updated</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>request body with documents ids</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">undefined</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Documents' nature(s) deleted</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Document not found or does not belong to current user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>The caches were refreshed successfully</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">index</td>
<td>
<input class="parameter" minlength="0" name="index" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The index of the pagination</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">max_results</td>
<td>
<input class="parameter" minlength="0" name="max_results" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The maximum number of results returned</p>
</td>
<td>query</td>
<td>
<span class="model-signature">integer</span>
</td>
</tr>
<tr>
<td class="code">since_id</td>
<td>
<input class="parameter" minlength="0" name="since_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created after the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">max_id</td>
<td>
<input class="parameter" minlength="0" name="max_id" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The returned items should be created before the item whose id is the given field</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">type</td>
<td>
<input class="parameter" minlength="0" name="type" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>The type of the returned items</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">status</td>
<td>
<select class="parameter" name="status">
<option selected="" value=""></option>
<option value="ARCHIVED">ARCHIVED</option>
<option value="NOT_ARCHIVED">NOT_ARCHIVED</option>
</select>
</td>
<td class="markdown">
<p>Status of timeline events</p>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">status</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="status"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Status of timeline events</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TimelineStatusInput {</span>
<div><span class="propName false">hidden</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">archived</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">hidden</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">archived</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">item_id</td>
<td>
<input class="parameter required" minlength="1" name="item_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">status</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="status"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Status of timeline events</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TimelineStatusInput {</span>
<div><span class="propName false">hidden</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">archived</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">hidden</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">archived</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">trusted_contact_id</td>
<td>
<input class="parameter required" minlength="1" name="trusted_contact_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The requested trusted contact does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">trusted_contact_id</td>
<td>
<input class="parameter required" minlength="1" name="trusted_contact_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The requested trusted contact does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">trusted_contact_id</td>
<td>
<input class="parameter required" minlength="1" name="trusted_contact_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The requested trusted contact does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The trusted contact's status is not WAITING</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">trusted_contact_id</td>
<td>
<input class="parameter required" minlength="1" name="trusted_contact_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>The requested trusted contact does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The trusted contact's status is not WAITING</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">trusted_contact_id</td>
<td>
<input class="parameter required" minlength="1" name="trusted_contact_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TrustedContactStatusInput {</span>
<div><span class="propWrap"><span class="propName true">status</span> (<span class="propType">string</span>) = <span class="propVals">['REFUSED' or 'WAITING' or 'ACCEPTED']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">status</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"REFUSED", "WAITING", "ACCEPTED"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">status</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>The status 'WAITING' is not accepted</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>The requested trusted contact does not exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Trusted Contact Info</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TrustedContactInput {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">given_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">given_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">family_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">family_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">given_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">family_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Input data are incorrect</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>The user can't add himself as a trusted contact</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The user account to create</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PinpadFullUserAccountInput {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">user_type</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName true">last_name</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName true">first_name</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">login</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">login</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[A-Za-z0-9_\-@\.\+]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">siren_siret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">company_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_question</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_question_index</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_answer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">optin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">idn_information</span> (<span class="propType">IDNInformation</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_optin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">address</span> (<span class="propType">AddressInput</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">accept_full_dematerialization</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locale</span> (<span class="propType">Locale</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">password</span> (<span class="propType">PinpadInput</span>),</div>
<div><span class="propName false">raw_password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">valid_secret_question_data</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">valid</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">IDNInformation {</span>
<div><span class="propName false">prefix</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">birth_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">idn_information_signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email_signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">AddressInput {</span>
<div><span class="propName false">sub_locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">street_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">post_office_box</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extended_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Locale {</span>
<div><span class="propName false">language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">script</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">variant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extension_keys</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">unicode_locale_attributes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">unicode_locale_keys</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">iso3_language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">iso3_country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_script</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_variant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">PinpadInput {</span>
<div><span class="propWrap"><span class="propName false">input</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">input</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>[0-9]{6}</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">sequence</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">password</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">user_type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">login</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">siren_siret</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">company_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_question</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_question_index</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">secret_answer</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">optin</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">idn_information</span>": <span class="value">{
"<span class="attribute">prefix</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">birth_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">city</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">idn_information_signature</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email_signature</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">id</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">partner_optin</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">address</span>": <span class="value">{
"<span class="attribute">sub_locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">street_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">post_office_box</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extended_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country_code</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">accept_full_dematerialization</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">locale</span>": <span class="value">{
"<span class="attribute">language</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">script</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">variant</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extension_keys</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">unicode_locale_attributes</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">unicode_locale_keys</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">iso3_language</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">iso3_country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_language</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_script</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_variant</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_name</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">password</span>": <span class="value">{
"<span class="attribute">input</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">sequence</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">password</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">raw_password</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">valid_secret_question_data</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">valid</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">registrationId</td>
<td>
<input class="parameter" minlength="0" name="registrationId" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>pré-registration identifier</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">fieldValue1</td>
<td>
<input class="parameter" minlength="0" name="fieldValue1" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Sender Security+ form field1 value</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">fieldValue2</td>
<td>
<input class="parameter" minlength="0" name="fieldValue2" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Sender Security+ form field2 value</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tokenCustomization</td>
<td>
<input class="parameter" minlength="0" name="tokenCustomization" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>customization token (coregistration)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">trustedContactId</td>
<td>
<input class="parameter" minlength="0" name="trustedContactId" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>trusted contact identifier</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>cannot creates user with this parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>login already exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">user_id</td>
<td>
<input class="parameter required" minlength="1" name="user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The user id to retrieve</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>invalid id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>no user with this id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The user account to create</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">RawPasswordFullUserAccountInput {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">user_type</span> (<span class="propType">string</span>),</div>
<div><span class="propWrap"><span class="propName true">last_name</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName true">first_name</span> (<span class="propType">string</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">login</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">login</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[A-Za-z0-9_\-@\.\+]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">siren_siret</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">company_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_question</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_question_index</span> (<span class="propType">integer</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">secret_answer</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">optin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">idn_information</span> (<span class="propType">IDNInformation</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_optin</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">address</span> (<span class="propType">AddressInput</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">accept_full_dematerialization</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locale</span> (<span class="propType">Locale</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">password</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">raw_password</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">valid_secret_question_data</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">valid</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">IDNInformation {</span>
<div><span class="propName false">prefix</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">birth_date</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">city</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">idn_information_signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">email_signature</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">AddressInput {</span>
<div><span class="propName false">sub_locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">street_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">postal_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">post_office_box</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">locality</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extended_address</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country_code</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span><br><span class="strong">Locale {</span>
<div><span class="propName false">language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">script</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">variant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">extension_keys</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">unicode_locale_attributes</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">unicode_locale_keys</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">iso3_language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">iso3_country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_language</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_script</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_country</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_variant</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">display_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">user_type</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">login</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">siren_siret</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">company_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_question</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">secret_question_index</span>": <span class="value"><span class="number">0</span></span>,
"<span class="attribute">secret_answer</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">optin</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">idn_information</span>": <span class="value">{
"<span class="attribute">prefix</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">birth_date</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">city</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">idn_information_signature</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email_signature</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">id</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">partner_optin</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">address</span>": <span class="value">{
"<span class="attribute">sub_locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">street_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">postal_code</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">post_office_box</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">locality</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extended_address</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country_code</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">accept_full_dematerialization</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">locale</span>": <span class="value">{
"<span class="attribute">language</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">script</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">variant</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">extension_keys</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">unicode_locale_attributes</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">unicode_locale_keys</span>": <span class="value">[
<span class="string">"string"</span>
]</span>,
"<span class="attribute">iso3_language</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">iso3_country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_language</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_script</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_country</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_variant</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">display_name</span>": <span class="value"><span class="string">"string"</span>
}</span></span>,
"<span class="attribute">password</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">raw_password</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">valid_secret_question_data</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">valid</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
<tr>
<td class="code">registrationId</td>
<td>
<input class="parameter" minlength="0" name="registrationId" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>pré-registration identifier</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">fieldValue1</td>
<td>
<input class="parameter" minlength="0" name="fieldValue1" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Sender Security+ form field1 value</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">fieldValue2</td>
<td>
<input class="parameter" minlength="0" name="fieldValue2" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Sender Security+ form field2 value</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">tokenCustomization</td>
<td>
<input class="parameter" minlength="0" name="tokenCustomization" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>customization token (coregistration)</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
<tr>
<td class="code">trustedContactId</td>
<td>
<input class="parameter" minlength="0" name="trustedContactId" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>trusted contact identifier</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>cannot creates user with this parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>login already exist</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The partial user account payload</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PartialAccountInput {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">birth_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">birth_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">with_membership_creation</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">birth_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">with_membership_creation</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">409</td>
<td>client id already exist for current partner</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>le user_id est manquant</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>le compte a déjà été transformé</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>utilisateur non trouvé</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">PartialAccountFullInput {</span>
<div><span class="propName false">title</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">last_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">last_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propWrap"><span class="propName false">first_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">first_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">date_of_birth</span> (<span class="propType">date</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName false">birth_name</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">birth_name</th>
</tr>
<tr>
<td class="optionName">Reg. Exp.:</td>
<td>^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$</td>
</tr>
</tbody>
</table></span>,</div>
<div><span class="propName false">email</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">purchase_transaction</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName true">platform</span> (<span class="propType">string</span>),</div>
<div><span class="propName false">product_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_plan</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">title</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">last_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">first_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">date_of_birth</span>": <span class="value"><span class="string">"2024-09-23"</span></span>,
"<span class="attribute">birth_name</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">email</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">purchase_transaction</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">platform</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">product_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">partner_plan</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Wrong or missing mandatory parameters, or unknown platform</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Product_id not found</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>partner_user_id or purchase_transaction already exist for current partner</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The coregistration info of partial account</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CoregPartnerUserInput {</span>
<div><span class="propName false">coreg_partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">coreg_partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">partner_id</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>partial account is not authorized to be merged with a company account</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>partial account and full account both have a membership to the same sender who does not allow multiple memberships for the same user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>The coregistration infos concerning merge</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CheckPartialAccountMergeInput {</span>
<div><span class="propName false">coreg_partner_user_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">partner_id</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">login</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">ccu</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propWrap"><span class="propName true">kind</span> (<span class="propType">string</span>) = <span class="propVals">['PERSON' or 'COMPANY']</span>
<table class="optionsWrapper">
<tbody>
<tr>
<th colspan="2">kind</th>
</tr>
<tr>
<td class="optionName">Enum:</td>
<td>"PERSON", "COMPANY"</td>
</tr>
</tbody>
</table>
</span></div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">coreg_partner_user_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">partner_id</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">login</span>": <span class="value"><span class="string">"string"</span></span>,
"<span class="attribute">ccu</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">kind</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>partial account is not authorized to be merged with a company account</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>partial account and full account both have a membership to the same sender who does not allow multiple memberships for the same user</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">email</td>
<td>
<input class="parameter required" minlength="1" name="email" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Email for which we will search user's accounts</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">pid</td>
<td>
<input class="parameter" minlength="0" name="pid" placeholder="" type="text" value="">
</td>
<td class="markdown">
<p>Sender's public id for validations on membership</p>
</td>
<td>query</td>
<td>
<span class="model-signature">string</span>
</td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>invalid parameters</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">ccu_user_id</td>
<td>
<input class="parameter required" minlength="1" name="ccu_user_id" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>The CCU_USER_ID of the user to retrieve</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>invalid ccu_user_id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>no user with this ccu_user_id</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">email</td>
<td>
<input class="parameter required" minlength="1" name="email" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid check data (user or email)</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">Update data</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="Update data"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">CcuUpdateInput {</span>
<div><span class="propName false">token</span> (<span class="propType">string</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">token</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Invalid CCU user token</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">routeCode</td>
<td>
<input class="parameter required" minlength="1" name="routeCode" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>routeCode</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code required">personalised</td>
<td>
<input class="parameter required" minlength="1" name="personalised" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>personalised</p>
</span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">404</td>
<td>no user found with this routeCode</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown">
<p>Add user consent</p>
</span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserConsentInput {</span>
<div><span class="propName true">consent_type</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">consent_type</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">201</td>
<td>Created successfully.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Incorrect input values.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Trying to add same consent to the same user.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">consent_type</td>
<td>
<input class="parameter required" minlength="1" name="consent_type" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown">
<p>Consent Type</p>
</span></strong>
</td>
<td>path</td>
<td><span class="model-signature">string</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>Deleted successfully.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">400</td>
<td>Incorrect input values.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">404</td>
<td>Trying to remove an inexistant consent.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code">consent_data_team</td>
<td>
<select class="parameter" name="consent_data_team">
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>path</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">204</td>
<td>the consentData flag is not a valid boolean (true or false)</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">email</td>
<td>
<input class="parameter required" minlength="1" name="email" placeholder="(required)" type="text" value="">
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>query</td>
<td><span class="model-signature">string</span></td>
</tr>
<tr>
<td class="code">mail_valid</td>
<td>
<select class="parameter" name="mail_valid">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
<tr>
<td class="code">ccu_linked</td>
<td>
<select class="parameter" name="ccu_linked">
<option selected="" value=""></option>
<option value="true">true</option>
<option value="false">false</option>
</select>
</td>
<td class="markdown"></td>
<td>query</td>
<td><span class="model-signature">boolean</span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">UserSecurityTwoFactorInput {</span>
<div><span class="propName false">status</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">valid_statuses</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">sms_status</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>),</div>
<div><span class="propName false">totp_status</span> (<span class="propType">boolean</span>, <span class="propOptKey">optional</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">status</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">valid_statuses</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">sms_status</span>": <span class="value"><span class="literal">true</span></span>,
"<span class="attribute">totp_status</span>": <span class="value"><span class="literal">true</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">400</td>
<td>Status may not be null.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">403</td>
<td>Action requires reinforced token</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">409</td>
<td>Inconsistent update status.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<h4>Parameters</h4>
<table class="fullwidth">
<thead>
<tr>
<th style="width: 100px; max-width: 100px">Parameter</th>
<th style="width: 310px; max-width: 310px">Value</th>
<th style="width: 200px; max-width: 200px">Description</th>
<th style="width: 100px; max-width: 100px">Parameter Type</th>
<th style="width: 220px; max-width: 230px">Data Type</th>
</tr>
</thead>
<tbody class="operation-params">
<tr>
<td class="code required">body</td>
<td>
<textarea class="body-textarea required" placeholder="(required)" name="body"></textarea>
<br>
<div class="parameter-content-type">
<div><label for="parameterContentType">Parameter content type:</label>
<select name="parameterContentType">
<option value="application/json">application/json</option>
</select>
</div>
</div>
</td>
<td>
<strong><span class="markdown"></span></strong>
</td>
<td>body</td>
<td><span class="model-signature">
<div>
<div>
<ul class="signature-nav">
<li><a class="description-link" href="#">Model</a></li>
<li><a class="snippet-link selected" href="#">Model Schema</a></li>
</ul>
<div>
<div class="signature-container">
<div class="description" style="display: none;">
<span class="strong">TotpInput {</span>
<div><span class="propName true">code</span> (<span class="propType">string</span>)</div><span class="strong">}</span>
</div>
<div class="snippet" style="display: block;">
<pre><code class="json">{
"<span class="attribute">code</span>": <span class="value"><span class="string">"string"</span>
}</span></code></pre>
<small class="notice">Click to set as parameter value</small>
</div>
</div>
</div>
</div>
</div>
</span></td>
</tr>
</tbody>
</table>
<div style="margin:0;padding:0;display:inline"></div>
<h4>Response Messages</h4>
<table class="fullwidth">
<thead>
<tr>
<th>HTTP Status Code</th>
<th>Reason</th>
<th>Response Model</th>
</tr>
</thead>
<tbody class="operation-status">
<tr>
<td width="15%" class="code">408</td>
<td>Pairing are no more available for the user </td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
<tr>
<td width="15%" class="code">412</td>
<td>Wrong PIN number.</td>
<td width="50%"><span class="model-signature"></span></td>
</tr>
</tbody>
</table>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form><form accept-charset="UTF-8" class="sandbox">
<div style="margin:0;padding:0;display:inline"></div>
<div class="sandbox_header">
<input class="submit" name="commit" type="button" value="Try it out!">
<a href="#" class="response_hider" style="display:none">Hide Response</a>
<span class="response_throbber" style="display:none"></span>
</div>
</form>Text Content
Digiposte API
2.03
PARTNERCLIENT
Explore
Log in
swagger digiposte api
* ACCOUNT
* Show/Hide
* List Operations
* Expand Operations
* * POST /ACCOUNT
* Create DGP account and/or add membership
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type account_input
Parameter content type: application/json
L'identifiant ccu de l'utilisateur et le code Regate (falcultatif)
body
* Model
* Model Schema
AccountInput {
ccu_user_id (string),
code_regate (string, optional)
}
{
"ccu_user_id": "string",
"code_regate": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Missing parameters 401 Access
denied 403 You don't have the rights to access this resource
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /ACCOUNT/CCU
* Create DGP account from CcuUserId. Used by invitation micro-service.
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type account_input
Parameter content type: application/json
L'identifiant ccu de l'utilisateur et le code Regate (falcultatif)
body
* Model
* Model Schema
AccountCreationInput {
ccu_user_id (string),
route_code (string)
}
{
"ccu_user_id": "string",
"route_code": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Missing parameters 401 Access
denied 403 You don't have the rights to access this resource
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* APPROVAL
* Show/Hide
* List Operations
* Expand Operations
* * POST /APPROVAL
* create approval
RESPONSE CLASS (STATUS 200)
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json text/json
body
* Model
* Model Schema
ApprovalInput {
client_id (string)
}
{
"client_id": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ARCHIVE
* Show/Hide
* List Operations
* Expand Operations
* * POST /DOCUMENT
* Upload a document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.480Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.480Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.480Z"
},
"valid_until": "2024-09-23T11:00:41.480Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.480Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.480Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.480Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.480Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type title
Parameter content type: multipart/form-data
The title of the document
body string tag
Parameter content type: multipart/form-data
The tag of the document. Can pass multiple tags separated by | or , char
body string hash
Parameter content type: multipart/form-data
The hash value of the document content
body string algo
Parameter content type: multipart/form-data
The hash algorithm to check the hash
body string folder_id
Parameter content type: multipart/form-data
Folder ID where the document will be stored
body string favorite true false
Favorite document ?
body booleanarchive_size
Parameter content type: multipart/form-data
Size of the archive
body long health_document true false
Health document
body booleannature_id
Parameter content type: multipart/form-data
Nature type of the document
body string X-AuthorizeSender true false header booleanarchive
The file to archive
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 The document hash is wrong 413 The document to upload is too large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENT/GEO
* Upload a document with latitude and longitude
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.485Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.485Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.485Z"
},
"valid_until": "2024-09-23T11:00:41.485Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.485Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.485Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.485Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.485Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type title
Parameter content type: multipart/form-data
The title of the document
body string tag
Parameter content type: multipart/form-data
The tag of the document. Can pass multiple tags separated by | or , char
body string hash
Parameter content type: multipart/form-data
The hash value of the document content
body string algo
Parameter content type: multipart/form-data
The hash algorithm to check the hash
body string timestamp
Parameter content type: multipart/form-data
The document timestamp
body string latitude
Parameter content type: multipart/form-data
The document latitude
body double longitude
Parameter content type: multipart/form-data
The document longitude
body double hdop
Parameter content type: multipart/form-data
The document hdop
body string folder_id
Parameter content type: multipart/form-data
Folder ID where the document will be stored
body string favorite true false
Favorite document ?
body booleanarchive_size
Parameter content type: multipart/form-data
Size of the archive
body long health_document true false
Health document
body booleanX-AuthorizeSender true false header booleanarchive
The file to archive
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 The document to upload is empty 413 The document to upload is too
large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENT/CERTIFIED
* Upload a certified document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.489Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.489Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.489Z"
},
"valid_until": "2024-09-23T11:00:41.489Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.489Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.489Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.489Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.489Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type title
Parameter content type: multipart/form-data
The title of the document.
body string subtitle
Parameter content type: multipart/form-data
The subtitle of the document
body string summary
Parameter content type: multipart/form-data
The summary of the document
body string tag
Parameter content type: multipart/form-data
The tag of the document. Can pass multiple tags separated by | or , char
body string hash
Parameter content type: multipart/form-data
The hash value of the document content.
body string algo
Parameter content type: multipart/form-data
The hash algorithm to check the hash.
body string location
Parameter content type: multipart/form-data
The location (inbox, classeur...)
body string type
Parameter content type: multipart/form-data
The type (facture, ...)
body string folder_id
Parameter content type: multipart/form-data
Folder ID where the document will be stored
body string favorite true false
Favorite document ?
body booleanarchive_size
Parameter content type: multipart/form-data
Size of the archive
body long archive
The file to archive
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 The document to upload is empty 413 The document to upload is too
large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENT/MERGE
* Generates a PDF from given files and stores it in the safe
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.493Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.493Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.493Z"
},
"valid_until": "2024-09-23T11:00:41.493Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.493Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.493Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.493Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.493Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type title
Parameter content type: multipart/form-data
The title of the document
body string tag
Parameter content type: multipart/form-data
The tag of the document. Can pass multiple tags separated by | or , char
body string folder_id
Parameter content type: multipart/form-data
Folder ID where the document will be stored
body string favorite true false
Favorite document ?
body booleanarchive_size
Parameter content type: multipart/form-data
Size of the archive
body long health_document true false
Health document
body booleannature_id
Parameter content type: multipart/form-data
Document nature
body string archives
The files to use to generate the PDF document
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 Not enough space left on the user strongbox 413 The total size of the
files to merge is too large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENT/MERGE/GEO
* Generates a PDF from given files and stores it in the safe
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.495Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.495Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.495Z"
},
"valid_until": "2024-09-23T11:00:41.495Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.495Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.495Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.495Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.495Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type title
Parameter content type: multipart/form-data
The title of the document
body string tag
Parameter content type: multipart/form-data
The tag of the document. Can pass multiple tags separated by | or , char
body string timestamp
Parameter content type: multipart/form-data
The document timestamp
body string latitude
Parameter content type: multipart/form-data
The document latitude
body double longitude
Parameter content type: multipart/form-data
The document longitude
body double hdop
Parameter content type: multipart/form-data
The document hdop
body string folder_id
Parameter content type: multipart/form-data
Folder ID where the document will be stored
body string favorite true false
Favorite document ?
body booleanarchive_size
Parameter content type: multipart/form-data
Size of the archive
body long health_document true false
Health document
body booleanarchives
The files to use to generate the PDF document
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 Not enough space left on the user strongbox 413 The total size of the
files to merge is too large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* AVATAR
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROFILE/AVATAR
* get user avatar
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 the user don't have a avatar
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/AVATAR
* change user avatar
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type avatar
The avatar to upload
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Upload OK
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROFILE/AVATAR
* delete avatar
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Avatar has been deleted.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CGU
* Show/Hide
* List Operations
* Expand Operations
* * GET /CGU
* Returns the CGU url and version
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CGUDto {
version (string, optional),
href (string, optional)
}
{
"version": "string",
"href": "string"
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* COLLECT
* Show/Hide
* List Operations
* Expand Operations
* * GET /COLLECT/{TRANSACTIONID}
* Return collect status from fiducéo
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipCollectStatus {
status_label (string, optional),
on_error (boolean, optional),
error_detail (string, optional) = ['LOGIN_FAIL' or 'PENDING' or
'CHECK_ACCOUNT' or 'CANCELLED' or 'BUG' or 'WEBSITE_UNAVAILABLE' or
'RATE_LIMITING']
error_detailEnum:"LOGIN_FAIL", "PENDING", "CHECK_ACCOUNT", "CANCELLED",
"BUG", "WEBSITE_UNAVAILABLE", "RATE_LIMITING"
,
done (boolean, optional),
nb_collecteds_documents (integer, optional),
efacture_status (string, optional) = ['PENDING' or 'SCHEDULED' or
'IN_PROGRESS' or 'COMPLETED' or 'COMPLETED_NOTHING_TO_DOWNLOAD' or
'COMPLETED_NOTHING_NEW_TO_DOWNLOAD' or 'COMPLETED_WITH_MISSING_DOCS' or
'CHECK_ACCOUNT' or 'LOGIN_FAILED' or 'UNEXPECTED_ACCOUNT_DATA' or
'DEMATERIALISATION_NEEDED' or 'WAIT_FOR_USER_ACTION' or 'REJECTED' or
'COMPLETED_WITH_ERRORS' or 'RETRIEVER_ERROR' or 'PROVIDER_UNAVAILABLE' or
'TIMEOUT' or 'BROKER_UNAVAILABLE' or 'CANCELLED']
efacture_statusEnum:"PENDING", "SCHEDULED", "IN_PROGRESS", "COMPLETED",
"COMPLETED_NOTHING_TO_DOWNLOAD", "COMPLETED_NOTHING_NEW_TO_DOWNLOAD",
"COMPLETED_WITH_MISSING_DOCS", "CHECK_ACCOUNT", "LOGIN_FAILED",
"UNEXPECTED_ACCOUNT_DATA", "DEMATERIALISATION_NEEDED",
"WAIT_FOR_USER_ACTION", "REJECTED", "COMPLETED_WITH_ERRORS",
"RETRIEVER_ERROR", "PROVIDER_UNAVAILABLE", "TIMEOUT",
"BROKER_UNAVAILABLE", "CANCELLED"
,
error_message (string, optional),
original_error_message (string, optional)
}
{
"status_label": "string",
"on_error": true,
"error_detail": "string",
"done": true,
"nb_collecteds_documents": 0,
"efacture_status": "string",
"error_message": "string",
"original_error_message": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId path
string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /COLLECT/{TRANSACTIONID}/2FA
* Send the 2FA code to fiducéo or powens
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type transactionId path
string body
Parameter content type: application/json
body
* Model
* Model Schema
TwoFaInput {
code (string, optional)
}
{
"code": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONTACT
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /CONTACT/{ID}/DOCUMENT/{DOCUMENT_ID}
* Supprime la reference du document associés au membre
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string document_id
the id of the document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Document not
found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CONTACT/{ID}/PICTURE
* get itemContact picture
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/PICTURE
* change member picture
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string picture
The picture to upload
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Upload OK 403 Forbidden 404
Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /CONTACT/{ID}/PICTURE
* delete picture
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Photo has been deleted. 403
Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/CALL_AGAIN_INVITATION
* Re-send mail invitation to contact member for the current user
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Your account cannot access to
this resource. 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/ANSWER_INVITATION
* accept invitation
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string accepted
Parameter content type: application/json
accept invitation ?
body
* Model
* Model Schema
ContactInvitationData {
accepted (boolean, optional)
}
{
"accepted": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Contact not found 409 user
can't answer his own invitation
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CONTACT/{ID}/DOCUMENTS
* Renvoit la liste des documents associés au membre
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.507Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.507Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.507Z"
},
"valid_until": "2024-09-23T11:00:41.507Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.507Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.507Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.507Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.507Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/PROCEDURE
* Ajoute une procedures associés au membre
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string user_procedure_id
Parameter content type: application/json
the id of the procedure
body
* Model
* Model Schema
UserProcedureIdInput {
user_procedure_id (string, optional)
}
{
"user_procedure_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Procedure not
found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /CONTACT/{ID}/PROCEDURE/{USER_PROCEDURE_ID}
* Retire une procedures associés au membre
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string user_procedure_id
the id of the procedure
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Procedure not
found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CONTACT/{ID}/TIMELINE
* Retrieve the timeline of a Contact member
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer since_id
The returned items should be created after the item whose id is the given
field
query string max_id
The returned items should be created before the item whose id is the
given field
query string type
The type of the returned items
query string status ARCHIVED NOT_ARCHIVED
Status of timeline events
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CONTACT/{ID}/PROCEDURES
* Renvoit la liste d'id des procedures associés au membre
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT
* Add a contact member for the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactData {
id (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
phone (string, optional),
email (string, optional),
relationship_type (string, optional) = ['GRANDPARENT' or 'PARENT' or
'PARTNER' or 'CHILD' or 'GRANDCHILD' or 'OTHER' or 'CONTACT']
relationship_typeEnum:"GRANDPARENT", "PARENT", "PARTNER", "CHILD",
"GRANDCHILD", "OTHER", "CONTACT"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
status (string, optional) = ['UNINVITED' or 'WAITING_VALIDATION' or
'VALID']
statusEnum:"UNINVITED", "WAITING_VALIDATION", "VALID"
,
share_id (string, optional)
}
{
"id": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"phone": "string",
"email": "string",
"relationship_type": "string",
"created_at": "2024-09-23T11:00:41.513Z",
"updated_at": "2024-09-23T11:00:41.513Z",
"photo": true,
"status": "string",
"share_id": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add contact member to current user's contact universe
body
* Model
* Model Schema
ContactInput {
last_name (string, optional)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string, optional)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
phone (string, optional),
email (string, optional),
relationship_type (string)
}
{
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"phone": "string",
"email": "string",
"relationship_type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 the given email is already
used for another relationship
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CONTACT/{ID}
* Get a contact member
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactData {
id (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
phone (string, optional),
email (string, optional),
relationship_type (string, optional) = ['GRANDPARENT' or 'PARENT' or
'PARTNER' or 'CHILD' or 'GRANDCHILD' or 'OTHER' or 'CONTACT']
relationship_typeEnum:"GRANDPARENT", "PARENT", "PARTNER", "CHILD",
"GRANDCHILD", "OTHER", "CONTACT"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
status (string, optional) = ['UNINVITED' or 'WAITING_VALIDATION' or
'VALID']
statusEnum:"UNINVITED", "WAITING_VALIDATION", "VALID"
,
share_id (string, optional)
}
{
"id": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"phone": "string",
"email": "string",
"relationship_type": "string",
"created_at": "2024-09-23T11:00:41.514Z",
"updated_at": "2024-09-23T11:00:41.514Z",
"photo": true,
"status": "string",
"share_id": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /CONTACT/{ID}
* Update a contact member for the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactData {
id (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
phone (string, optional),
email (string, optional),
relationship_type (string, optional) = ['GRANDPARENT' or 'PARENT' or
'PARTNER' or 'CHILD' or 'GRANDCHILD' or 'OTHER' or 'CONTACT']
relationship_typeEnum:"GRANDPARENT", "PARENT", "PARTNER", "CHILD",
"GRANDCHILD", "OTHER", "CONTACT"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
status (string, optional) = ['UNINVITED' or 'WAITING_VALIDATION' or
'VALID']
statusEnum:"UNINVITED", "WAITING_VALIDATION", "VALID"
,
share_id (string, optional)
}
{
"id": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"phone": "string",
"email": "string",
"relationship_type": "string",
"created_at": "2024-09-23T11:00:41.515Z",
"updated_at": "2024-09-23T11:00:41.515Z",
"photo": true,
"status": "string",
"share_id": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add contact member to current user's contact universe
body
* Model
* Model Schema
ContactInput {
last_name (string, optional)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string, optional)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
phone (string, optional),
email (string, optional),
relationship_type (string)
}
{
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"phone": "string",
"email": "string",
"relationship_type": "string"
}
Click to set as parameter value
id
The ID of the contact member
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /CONTACT/{ID}
* delete a contact member
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ContactData {
id (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
phone (string, optional),
email (string, optional),
relationship_type (string, optional) = ['GRANDPARENT' or 'PARENT' or
'PARTNER' or 'CHILD' or 'GRANDCHILD' or 'OTHER' or 'CONTACT']
relationship_typeEnum:"GRANDPARENT", "PARENT", "PARTNER", "CHILD",
"GRANDCHILD", "OTHER", "CONTACT"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
status (string, optional) = ['UNINVITED' or 'WAITING_VALIDATION' or
'VALID']
statusEnum:"UNINVITED", "WAITING_VALIDATION", "VALID"
,
share_id (string, optional)
}
{
"id": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"phone": "string",
"email": "string",
"relationship_type": "string",
"created_at": "2024-09-23T11:00:41.516Z",
"updated_at": "2024-09-23T11:00:41.516Z",
"photo": true,
"status": "string",
"share_id": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/DOCUMENT
* Ajoute un document au membre courant
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
The ID of the contact member
path string body
Parameter content type: application/json
the id of the document
body
* Model
* Model Schema
DocumentIdInput {
document_id (string, optional)
}
{
"document_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Member not found
409 the given document id has been already added
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONTACT_SHARE
* Show/Hide
* List Operations
* Expand Operations
* * GET /CONTACT/{ID}/SHARE/DOCUMENTS
* get all shared documents
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Identifiant du contact
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 User not allowed to get
documents from share 404 share not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/SHARE/DOCUMENTS
* add documents to share
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Identifiant du contact
path string body
Parameter content type: application/json
Les ids des documents à mettre dans le partage
body
* Model
* Model Schema
IdSet {
ids (string)
}
{
"ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Document list is emtpty 403
User not allowed to add documents to share 404 share not found 409
Document(s) already exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /CONTACT/{ID}/SHARE/DOCUMENTS
* delete documents from share
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Identifiant du contact
path string body
Parameter content type: application/json
Les ids des documents à mettre dans le partage
body
* Model
* Model Schema
IdSet {
ids (string)
}
{
"ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Document(s) has been deleted
from share 403 User not allowed to delete documents from share 404 Share
not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CONTACT/{ID}/SHARE/DOCUMENTS/COPY
* Save shared documents
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.521Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.521Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.521Z"
},
"valid_until": "2024-09-23T11:00:41.521Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.521Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.521Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.521Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.521Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Identifiant du contact
path string body
Parameter content type: application/json
body
* Model
* Model Schema
ContactShareCopy {
folder_id (string, optional),
documents (string, optional)
}
{
"folder_id": "string",
"documents": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 User not allowed to access to
document
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CONTACT/{ID}/SHARE/CONTENT
* Returns the document content
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Identifiant du contact
path string document_id
Identifiant du document à télécharger
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 User not allowed to get
documents from share 404 share not found 409 Document(s) is not share
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CONTACTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /CONTACTS
* return all contact of the current user
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CREDENTIALS
* Show/Hide
* List Operations
* Expand Operations
* * GET /CREDENTIALS/SECRET_QUESTION
* search if the user have a secret question defined
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserSecretQuestionSigned {
secret_question_find (boolean)
}
{
"secret_question_find": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type login query string
email query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 This login or email are
invalid
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CREDENTIALS/{EMAIL}/LOGINS
* Return login list available for given email
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
StringList {
values (string, optional)
}
{
"values": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type email path string
uri query string mail_valid true false query booleanccu_linked true false
query boolean
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /CREDENTIALS/{LOGIN}/QUESTION/MATCHES
* Verify that the given answer matches the user secret question
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The new secret question
body
* Model
* Model Schema
UserCredentialsQuestion {
secret_question (string, optional)
secret_questionReg. Exp.:^[\p{InCombiningDiacriticalMarks}\p{L}\d\s
?',-]{1,128}$
,
secret_question_index (integer, optional),
secret_question_answer (string, optional),
valid_secret_question_data (boolean, optional)
}
{
"secret_question": "string",
"secret_question_index": 0,
"secret_question_answer": "string",
"valid_secret_question_data": true
}
Click to set as parameter value
login
The user's login
path string uri
The URI of reset link
query string ccu true false query booleantype PERSON COMPANY query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid request parameters 409
the given answer matches the user secret question
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CREDENTIALS/RAW_PASSWORD/MATCHES
* Verify that the given password is correct
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The password to verify
body
* Model
* Model Schema
RawPasswordToVerifyData {
password (string, optional)
}
{
"password": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 the given password is
incorrect
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /CREDENTIALS/RAW_PASSWORD
* Updates the password
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The old password, and the new password
body
* Model
* Model Schema
RawPasswordUpdateData {
old_password (string, optional),
new_password (string, optional)
}
{
"old_password": "string",
"new_password": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The new password is too leak
412 the old password is incorrect
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /CREDENTIALS/LOGIN/CHANGE
* Initialisation d'un changement de login
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The data for update login payload
body
* Model
* Model Schema
LoginChangeInput {
new_login (string, optional),
old_login (string, optional),
password (string, optional),
type (string, optional)
}
{
"new_login": "string",
"old_login": "string",
"password": "string",
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 the given password is
incorrect
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /CREDENTIALS/{CODE}/VALID
* Validation d'un changement de login
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LoginChangeData {
user_id (string, optional),
code (string, optional),
type (string, optional) = ['PERSON' or 'COMPANY']
typeEnum:"PERSON", "COMPANY"
,
value (string, optional),
ccu_user_id (string, optional)
}
{
"user_id": "string",
"code": "string",
"type": "string",
"value": "string",
"ccu_user_id": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type code
The validation code
path string token query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 There is no user associated to
this code
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* CUSTOMIZATIONURL
* Show/Hide
* List Operations
* Expand Operations
* * POST /USER/CUSTOMIZATIONURL
* create new token for user or renew them
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CustomizationUrlOutput {
customization_url (string, optional)
}
{
"customization_url": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
PartialAccountTypedInput {
title (string, optional),
last_name (string, optional)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string, optional)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
birth_name (string, optional)
birth_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
email (string, optional),
partner_user_id (string, optional),
user_type (string, optional)
user_typeReg. Exp.:^(PERSON)|(COMPANY)$
,
company_name (string, optional),
company_mandatory_attributs_set_or_null (boolean, optional)
}
{
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"birth_name": "string",
"email": "string",
"partner_user_id": "string",
"user_type": "string",
"company_name": "string",
"company_mandatory_attributs_set_or_null": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 le user_id est manquant 403 le
partenaire n'est pas propriétaire du compte 404 utilisateur non trouvé
409 le compte a déjà été transformé
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DASHBOARD
* Show/Hide
* List Operations
* Expand Operations
* * GET /DASHBOARD
* Returns the dashboard
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Dashboard {
number_of_documents (long, optional),
number_of_shares (long, optional),
number_of_collected_memberships (long, optional),
number_of_memberships (long, optional),
number_of_unread_documents (long, optional),
number_of_documents_in_inbox (long, optional),
number_of_read_documents_in_inbox (long, optional),
number_of_unread_documents_in_inbox (long, optional),
number_of_documents_in_safe (long, optional),
number_of_certified_documents_in_safe (long, optional),
number_of_personnal_documents_in_safe (long, optional),
addresses (Array[ProfileAddressData], optional),
memberships (Array[MembershipMetaData], optional),
trusted_contacts (Array[TrustedContactData], optional),
legators (Array[Legator], optional)
}
ProfileAddressData {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
id (string, optional),
address_alias (string, optional)
address_aliasReg. Exp.:.{1,55}
,
valid (boolean, optional)
}
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
TrustedContactData {
id (string, optional),
title (string, optional),
given_name (string, optional),
family_name (string, optional),
email (string, optional),
date_of_birth (date, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
legator (LegatorData, optional)
}
LegatorData {
given_name (string, optional),
family_name (string, optional)
}
Legator {
id (string, optional),
given_name (string, optional),
family_name (string, optional),
login (string, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
trusted_contact_id (string, optional)
}
{
"number_of_documents": 0,
"number_of_shares": 0,
"number_of_collected_memberships": 0,
"number_of_memberships": 0,
"number_of_unread_documents": 0,
"number_of_documents_in_inbox": 0,
"number_of_read_documents_in_inbox": 0,
"number_of_unread_documents_in_inbox": 0,
"number_of_documents_in_safe": 0,
"number_of_certified_documents_in_safe": 0,
"number_of_personnal_documents_in_safe": 0,
"addresses": [
{
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"id": "string",
"address_alias": "string",
"valid": true
}
],
"memberships": [
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.532Z",
"membership_date": "2024-09-23T11:00:41.532Z",
"request_date": "2024-09-23T11:00:41.532Z",
"cancellation_date": "2024-09-23T11:00:41.532Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.532Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.532Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.532Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.532Z"
}
}
],
"trusted_contacts": [
{
"id": "string",
"title": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"date_of_birth": "2024-09-23",
"status": "string",
"legator": {
"given_name": "string",
"family_name": "string"
}
}
],
"legators": [
{
"id": "string",
"given_name": "string",
"family_name": "string",
"login": "string",
"status": "string",
"trusted_contact_id": "string"
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DEVICE
* Show/Hide
* List Operations
* Expand Operations
* * POST /DEVICE
* update user device
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
the that will be created
body
* Model
* Model Schema
DeviceData {
token (string),
type (string),
version (string, optional)
}
{
"token": "string",
"type": "string",
"version": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 201 the new association was
created 400 Unknown device type or empty token 404 Unknown device
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /DEVICE
* delete user device
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
the device to delete
body
* Model
* Model Schema
DeviceData {
token (string),
type (string),
version (string, optional)
}
{
"token": "string",
"type": "string",
"version": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 201 the new association was
deleted 400 Unknown device type or empty token
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DEVICES
* Show/Hide
* List Operations
* Expand Operations
* * GET /DEVICES
* get user devices
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOCUMENT
* Show/Hide
* List Operations
* Expand Operations
* * PUT /DOCUMENT/{DOCUMENT_ID}/TAGS/{TAGS}
* Update tags of the document, the old tags will be overriden
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.535Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.535Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.535Z"
},
"valid_until": "2024-09-23T11:00:41.535Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.535Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.535Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.535Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.535Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id path
string tags path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Tags are not properly
formatted 404 The document doesn't exists
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENT/{DOCUMENT_ID}/REMINDERS
* Get list of reminders of a document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ReminderDataList {
reminders (Array[ReminderData], optional)
}
ReminderData {
id (string, optional),
title (string),
date (date-time),
document_id (string, optional),
procedure_id (string, optional)
}
{
"reminders": [
{
"id": "string",
"title": "string",
"date": "2024-09-23T11:00:41.537Z",
"document_id": "string",
"procedure_id": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Reminders not found 500
Internal error
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENT/{DOCUMENT_ID}/WITH_SHARES
* Returns the document metadata with relative shares
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaDataWithShareData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional),
share_datas (Array[ShareData], optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.537Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.537Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.537Z"
},
"valid_until": "2024-09-23T11:00:41.537Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.537Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.537Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.537Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.537Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string",
"share_datas": [
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.537Z",
"end_date": "2024-09-23T11:00:41.537Z",
"last_view_at": "2024-09-23T11:00:41.537Z",
"created_at": "2024-09-23T11:00:41.537Z",
"updated_at": "2024-09-23T11:00:41.537Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENT/{DOCUMENT_ID}/THUMBNAIL
* Returns the document thumbnail
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /DOCUMENT/{DOCUMENT_ID}/READ_STATUS/{READ_STATUS}
* Update the read status of the document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.539Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.539Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.539Z"
},
"valid_until": "2024-09-23T11:00:41.539Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.539Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.539Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.539Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.539Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id path
string read_status true false path boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exists
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /DOCUMENT/{DOCUMENT_ID}/FAVORITE_STATUS/{FAVORITE_STATUS}
* Update the read status of the document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.541Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.541Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.541Z"
},
"valid_until": "2024-09-23T11:00:41.541Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.541Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.541Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.541Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.541Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id path
string favorite_status true false path boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exists
409 The document to mark as read/unread must not be already in this state
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENT/{DOCUMENT_ID}/VERIFY
* Verify a document
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENT/{DOCUMENT_ID}/REMINDER
* Create a reminder on a document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.542Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.542Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.542Z"
},
"valid_until": "2024-09-23T11:00:41.542Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.542Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.542Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.542Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.542Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string body
Parameter content type: application/json
Title and date of reminder that will be created
body
* Model
* Model Schema
ReminderInput {
title (string),
date (date-time)
}
{
"title": "string",
"date": "2024-09-23T11:00:41.467Z"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Title or date are invalids 404
document not found 500 Internal error
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENT/{DOCUMENT_ID}/CERTIFICATE
* get document certificate
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENT/{DOCUMENT_ID}
* Returns the document metadata
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.544Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.544Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.544Z"
},
"valid_until": "2024-09-23T11:00:41.544Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.544Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.544Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.544Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.544Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /DOCUMENT/{DOCUMENT_ID}
* Delete a document in trash
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exist 409
The document to delete must be in trash
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /DOCUMENT/{DOCUMENT_ID}/RENAME/{NEW_NAME}
* Rename the document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.546Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.546Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.546Z"
},
"valid_until": "2024-09-23T11:00:41.546Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.546Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.546Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.546Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.546Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id path
string new_name path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exists
409 Certified document cannot be renamed
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENT/{DOCUMENT_ID}/CONTENT
* Returns the document content
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id
Identifiant du document à télécharger
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /DOCUMENT/{DOCUMENT_ID}/CLASSIFY
* Classify the document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.547Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.547Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.547Z"
},
"valid_until": "2024-09-23T11:00:41.547Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.547Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.547Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.547Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.547Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type document_id path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The document doesn't exists
409 The document to classify must be in inbox
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOCUMENTS
* Show/Hide
* List Operations
* Expand Operations
* * POST /DOCUMENTS/CHOOSE
* Returns all user's documents that match the search
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.549Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.549Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.549Z"
},
"valid_until": "2024-09-23T11:00:41.549Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.549Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.549Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.549Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.549Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The search criteria
body
* Model
* Model Schema
ChooseDocsCriteria {
natures (Array[NatureCriteria], optional),
start_date (date-time),
end_date (date-time, optional)
}
NatureCriteria {
nature_pid (string),
limit (integer, optional)
}
{
"natures": [
{
"nature_pid": "string",
"limit": 0
}
],
"start_date": "2024-09-23T11:00:41.468Z",
"end_date": "2024-09-23T11:00:41.468Z"
}
Click to set as parameter value
sort FILENAME SIZE CREATION_DATE
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query stringuse_finder_search true false
Use finder backend for research
query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Nature PID is not a valid
value.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/SHARES/{PARTNERUSERID}/SHAREDFOLDERS
* Returns the folders tree
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
array {
}
[
{
"tree": {
"folders": [
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.552Z",
"updated_at": "2024-09-23T11:00:41.552Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0,
"folders": [
"FolderTreeView"
]
}
],
"document_count": 0
},
"root_id": "string",
"root_name": "string",
"document_count": 0
}
]
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partnerUserId path
string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS
* Returns all user's documents
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.553Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.553Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.553Z"
},
"valid_until": "2024-09-23T11:00:41.553Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.553Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.553Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.553Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.553Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer sort TYPE TITLE FILENAME AUTHOR_NAME CREATION_DATE WAS_READ
LOCATION IS_SHARED SIZE DIGISHOOT CHARGEABLE_AMOUNT
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/SHARES/{PARTNER_USER_ID}
* Returns metadata of documents included in sender share (handled by
microservice share) identified by senderId and partnerUserId
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SharedDocumentOutput {
shared_documents (SharedDocuments, optional)
}
SharedDocuments {
user_documents (Array[SharedDocument], optional),
sender_documents (Array[SharedDocument], optional)
}
SharedDocument {
document_id (string, optional),
filename (string, optional),
size (integer, optional),
health (boolean, optional),
type (string, optional),
origin (string, optional) = ['CERTIFIED' or 'COLLECTED' or 'PERSONAL']
originEnum:"CERTIFIED", "COLLECTED", "PERSONAL"
,
author_name (string, optional),
mimetype (string, optional),
created_at (date-time, optional),
folder_id (string, optional),
folder_name (string, optional)
}
{
"shared_documents": {
"user_documents": [
{
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.555Z",
"folder_id": "string",
"folder_name": "string"
}
],
"sender_documents": {
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.555Z",
"folder_id": "string",
"folder_name": "string"
}
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partner_user_id path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad request
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENTS/SHARES/{PARTNER_USER_ID}
* Returns metadata of documents included in sender share (handled by
microservice share) identified by senderId and partnerUserId
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SharedDocumentOutput {
shared_documents (SharedDocuments, optional)
}
SharedDocuments {
user_documents (Array[SharedDocument], optional),
sender_documents (Array[SharedDocument], optional)
}
SharedDocument {
document_id (string, optional),
filename (string, optional),
size (integer, optional),
health (boolean, optional),
type (string, optional),
origin (string, optional) = ['CERTIFIED' or 'COLLECTED' or 'PERSONAL']
originEnum:"CERTIFIED", "COLLECTED", "PERSONAL"
,
author_name (string, optional),
mimetype (string, optional),
created_at (date-time, optional),
folder_id (string, optional),
folder_name (string, optional)
}
{
"shared_documents": {
"user_documents": [
{
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.555Z",
"folder_id": "string",
"folder_name": "string"
}
],
"sender_documents": {
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.555Z",
"folder_id": "string",
"folder_name": "string"
}
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partner_user_id path
string body
Parameter content type: application/json
body
* Model
* Model Schema
DocumentIdsInput {
document_ids (string)
}
{
"document_ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad request
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/SENDERS/{SENDER_ID}/SHARES/{PARTNER_USER_ID}
* Returns metadata of documents included in sender share (handled by
microservice share) identified by senderId and partnerUserId
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SharedDocumentOutput {
shared_documents (SharedDocuments, optional)
}
SharedDocuments {
user_documents (Array[SharedDocument], optional),
sender_documents (Array[SharedDocument], optional)
}
SharedDocument {
document_id (string, optional),
filename (string, optional),
size (integer, optional),
health (boolean, optional),
type (string, optional),
origin (string, optional) = ['CERTIFIED' or 'COLLECTED' or 'PERSONAL']
originEnum:"CERTIFIED", "COLLECTED", "PERSONAL"
,
author_name (string, optional),
mimetype (string, optional),
created_at (date-time, optional),
folder_id (string, optional),
folder_name (string, optional)
}
{
"shared_documents": {
"user_documents": [
{
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.556Z",
"folder_id": "string",
"folder_name": "string"
}
],
"sender_documents": {
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.556Z",
"folder_id": "string",
"folder_name": "string"
}
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type sender_id path
string partner_user_id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad request
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENTS/METADATA
* Returns metadata of documents included in documents id array
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SharedDocumentOutput {
shared_documents (SharedDocuments, optional)
}
SharedDocuments {
user_documents (Array[SharedDocument], optional),
sender_documents (Array[SharedDocument], optional)
}
SharedDocument {
document_id (string, optional),
filename (string, optional),
size (integer, optional),
health (boolean, optional),
type (string, optional),
origin (string, optional) = ['CERTIFIED' or 'COLLECTED' or 'PERSONAL']
originEnum:"CERTIFIED", "COLLECTED", "PERSONAL"
,
author_name (string, optional),
mimetype (string, optional),
created_at (date-time, optional),
folder_id (string, optional),
folder_name (string, optional)
}
{
"shared_documents": {
"user_documents": [
{
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.557Z",
"folder_id": "string",
"folder_name": "string"
}
],
"sender_documents": {
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"origin": "string",
"author_name": "string",
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.557Z",
"folder_id": "string",
"folder_name": "string"
}
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
DocumentIdsInput {
document_ids (string)
}
{
"document_ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad request
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/SAFE
* Returns all user's documents which are in the strongbox
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.558Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.558Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.558Z"
},
"valid_until": "2024-09-23T11:00:41.558Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.558Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.558Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.558Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.558Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer sort TYPE TITLE FILENAME AUTHOR_NAME CREATION_DATE WAS_READ
LOCATION IS_SHARED SIZE DIGISHOOT CHARGEABLE_AMOUNT
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENTS/BYNATURES
* Returns n-last documents for each given nature pid
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.559Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.559Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.559Z"
},
"valid_until": "2024-09-23T11:00:41.559Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.559Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.559Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.559Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.559Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
input with list of couple (pid, wanted)
body
* Model
* Model Schema
DynamicProcedureInput {
natures (Array[DynamicProcedureItemInput], optional),
extensions (string)
}
DynamicProcedureItemInput {
pid (string, optional),
wanted (integer, optional)
}
{
"natures": [
{
"pid": "string",
"wanted": 0
}
],
"extensions": [
"string"
]
}
Click to set as parameter value
safeOnly true false
to look for documents only in safe and inbox
query boolean
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/INBOX
* Returns all user's documents which are in the mailbox
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.561Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.561Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.561Z"
},
"valid_until": "2024-09-23T11:00:41.561Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.561Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.561Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.561Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.561Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer sort TYPE TITLE FILENAME AUTHOR_NAME CREATION_DATE WAS_READ
LOCATION IS_SHARED SIZE DIGISHOOT CHARGEABLE_AMOUNT
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/TRASH
* Returns all user's documents which are in the trash
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.562Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.562Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.562Z"
},
"valid_until": "2024-09-23T11:00:41.562Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.562Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.562Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.562Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.562Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer sort TYPE TITLE FILENAME AUTHOR_NAME CREATION_DATE WAS_READ
LOCATION IS_SHARED SIZE DIGISHOOT CHARGEABLE_AMOUNT
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOCUMENTS/USERTAGS
* Returns documents userTags of the user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TagsFacet {
tags (object, optional)
}
{
"tags": {}
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENTS/READ
* mark unread documents as read
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MarkedDocuments {
count (long, optional)
}
{
"count": 0
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOCUMENTS/SEARCH
* Returns all user's documents that match the search
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.564Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.564Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.564Z"
},
"valid_until": "2024-09-23T11:00:41.564Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.564Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.564Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.564Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.564Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The search criteria
body
* Model
* Model Schema
DocumentSearch {
locations (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationsEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
document_types (string, optional),
mimetypes (string, optional),
text (string, optional),
sender_names (string, optional),
author_names (string, optional),
user_tags (string, optional),
user_tags_operator (string, optional) = ['AND' or 'OR']
user_tags_operatorEnum:"AND", "OR"
,
sender_tags (string, optional),
sender_tags_operator (string, optional) = ['AND' or 'OR']
sender_tags_operatorEnum:"AND", "OR"
,
tags (string, optional),
tags_operator (string, optional) = ['AND' or 'OR']
tags_operatorEnum:"AND", "OR"
,
document_read (boolean, optional),
document_shared (boolean, optional),
document_digishoot (boolean, optional),
document_certified (boolean, optional),
creation_date_ranges (string, optional) = ['CURRENT_DAY' or
'CURRENT_WEEK' or 'CURRENT_MONTH' or 'CURRENT_YEAR' or
'BEFORE_CURRENT_YEAR']
creation_date_rangesEnum:"CURRENT_DAY", "CURRENT_WEEK", "CURRENT_MONTH",
"CURRENT_YEAR", "BEFORE_CURRENT_YEAR"
,
creation_date_ranges_operator (string, optional) = ['AND' or 'OR']
creation_date_ranges_operatorEnum:"AND", "OR"
,
document_sources (string, optional) = ['SENDER' or 'USER' or 'DIGIPOSTE']
document_sourcesEnum:"SENDER", "USER", "DIGIPOSTE"
,
references (string, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_removal (boolean, optional),
health (boolean, optional),
nature_pid (string, optional),
nature_pid_inputs (Array[DocumentNaturePidInput], optional)
}
DocumentNaturePidInput {
value (string, optional)
}
{
"locations": [
"string"
],
"document_types": [
"string"
],
"mimetypes": [
"string"
],
"text": "string",
"sender_names": [
"string"
],
"author_names": [
"string"
],
"user_tags": [
"string"
],
"user_tags_operator": "string",
"sender_tags": [
"string"
],
"sender_tags_operator": "string",
"tags": [
"string"
],
"tags_operator": "string",
"document_read": true,
"document_shared": true,
"document_digishoot": true,
"document_certified": true,
"creation_date_ranges": [
"string"
],
"creation_date_ranges_operator": "string",
"document_sources": [
"string"
],
"references": [
"string"
],
"folder_id": "string",
"favorite": true,
"user_removal": true,
"health": true,
"nature_pid": "string",
"nature_pid_inputs": [
{
"value": "string"
}
]
}
Click to set as parameter value
index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer sort TYPE TITLE FILENAME AUTHOR_NAME CREATION_DATE WAS_READ
LOCATION IS_SHARED SIZE DIGISHOOT CHARGEABLE_AMOUNT
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad user 406 Invalid search
filter value for Location
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* DOWNLOAD
* Show/Hide
* List Operations
* Expand Operations
* * GET /DOWNLOAD/ARCHIVE/STATUS
* Retrieve archive with all documents download's link
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOWNLOAD/DOCUMENTS/INFO
* Returns size of all documents, indicates whether the safe contains
health document and whether download is allowed
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DownloadInfo {
}
{}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOWNLOAD/DOCUMENTS
* Returns a zip file with all documents
RESPONSE CLASS (STATUS 200)
Response Content Type application/zip
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOWNLOAD/DOCUMENTS
* Returns a zip file with all documents
RESPONSE CLASS (STATUS 200)
Response Content Type */*
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add document to user procedure
body
* Model
* Model Schema
DownloadInput {
document_ids (string, optional),
folder_ids (string, optional),
empty (boolean, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
],
"empty": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOWNLOAD/PROCEDURE/{PROCEDURE_ID}
* Save procedure's documents in a zip file
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type procedure_id path
string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOWNLOAD/PROFILE/DOCUMENTS
* Save profile's documents in a zip file
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOWNLOAD/PARTNER/ARCHIVES
* Start archive documents for partner users
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json text/plain
body Array[#/definitions/PartnerOneClickDownloadRequest]
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /DOWNLOAD/ARCHIVE
* Retrieve archive with all documents download
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partNumber
The number of archive part
query integer
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /DOWNLOAD/ARCHIVE
* Start archive with all documents creation
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json text/plain
body
* Model
* Model Schema
OneClickDownloadRequest {
password (string, optional)
}
{
"password": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /DOWNLOAD/ARCHIVE
* Delete archive
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* FILE_TREE
* Show/Hide
* List Operations
* Expand Operations
* * POST /FILE/TREE/TRASH
* Move documents and folders to trash
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TrashActionResponse {
involved_documents (long, optional),
unread_documents (Array[WarningDocumentOutput], optional),
certified_documents (Array[WarningDocumentOutput], optional),
shared_documents (Array[WarningDocumentOutput], optional),
procedure_documents (Array[WarningDocumentOutput], optional)
}
WarningDocumentOutput {
document_id (string, optional),
document_title (string, optional),
published_at (date-time, optional),
unread (boolean, optional),
certified (boolean, optional),
shares (Array[WarningShareOutput], optional),
procedures (Array[WarningProcedureOutput], optional)
}
WarningShareOutput {
id (string, optional),
title (string, optional)
}
WarningProcedureOutput {
id (string, optional),
title (string, optional)
}
{
"involved_documents": 0,
"unread_documents": [
{
"document_id": "string",
"document_title": "string",
"published_at": "2024-09-23T11:00:41.570Z",
"unread": true,
"certified": true,
"shares": [
{
"id": "string",
"title": "string"
}
],
"procedures": [
{
"id": "string",
"title": "string"
}
]
}
],
"certified_documents": {
"document_id": "string",
"document_title": "string",
"published_at": "2024-09-23T11:00:41.570Z",
"unread": true,
"certified": true,
"shares": [
{
"id": "string",
"title": "string"
}
],
"procedures": [
{
"id": "string",
"title": "string"
}
]
},
"shared_documents": {
"document_id": "string",
"document_title": "string",
"published_at": "2024-09-23T11:00:41.570Z",
"unread": true,
"certified": true,
"shares": [
{
"id": "string",
"title": "string"
}
],
"procedures": [
{
"id": "string",
"title": "string"
}
]
},
"procedure_documents": {
"document_id": "string",
"document_title": "string",
"published_at": "2024-09-23T11:00:41.570Z",
"unread": true,
"certified": true,
"shares": [
{
"id": "string",
"title": "string"
}
],
"procedures": [
{
"id": "string",
"title": "string"
}
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Folders and documents identifiants
body
* Model
* Model Schema
FileTreeInput {
document_ids (string, optional),
folder_ids (string, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
]
}
Click to set as parameter value
check true false query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Cannot trash because of wrong
location 409 Document or folder doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /FILE/TREE/TRASH
* Delete all documents and folders in trash
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /FILE/TREE/TRASH/RESTORE
* Restore all documents and folders in trash
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /FILE/TREE/UNDO/{ACTION_ID}
* Undo last user action with documents or folders
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type action_id path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Cannot undo action 409 Cannot
rename certified document
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /FILE/TREE/FAVORITE/{FAVORITE_STATUS}
* Update the favorite status of multiple documents at once
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MarkedDocuments {
count (long, optional)
}
{
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Folders and documents identifiants
body
* Model
* Model Schema
FileTreeInput {
document_ids (string, optional),
folder_ids (string, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
]
}
Click to set as parameter value
favorite_status true false path boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 At least one document/folder
is not owned by authenticated user 404 At least one of the
documents/folders to update the favorite status could not be found 409
Can't update the favorite status of so many documents/folders in a single
request
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /FILE/TREE/DELETE
* Delete documents and folders
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Folders and documents identifiants
body
* Model
* Model Schema
FileTreeInput {
document_ids (string, optional),
folder_ids (string, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Cannot restore because of
wrong location
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /FILE/TREE/RESTORE
* Restore documents and folders
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Folders and documents identifiants
body
* Model
* Model Schema
FileTreeInput {
document_ids (string, optional),
folder_ids (string, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Cannot restore because of
wrong location
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /FILE/TREE/INFO
* Returns documents and folders' size
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FileTreeInfo {
id (string, optional),
name (string, optional),
size (long, optional),
has_health_document (boolean, optional)
}
{
"id": "string",
"name": "string",
"size": 0,
"has_health_document": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Folders and documents infos
body
* Model
* Model Schema
FileTreeInput {
document_ids (string, optional),
folder_ids (string, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
]
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /FILE/TREE/MOVE
* Move a set of folders and documents
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type to
The target folder
query string body
Parameter content type: application/json
Folders and documents identifiants
body
* Model
* Model Schema
FileTreeInput {
document_ids (string, optional),
folder_ids (string, optional)
}
{
"document_ids": [
"string"
],
"folder_ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Document or folder doesn't
exist 409 Cannot move a folder into its child folders or itself
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* FOLDER
* Show/Hide
* List Operations
* Expand Operations
* * POST /FOLDER
* Creates new folder
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.576Z",
"updated_at": "2024-09-23T11:00:41.576Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
FolderInput {
name (string, optional),
favorite (boolean, optional),
parent_id (string, optional)
}
{
"name": "string",
"favorite": true,
"parent_id": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /FOLDER/{FOLDER_ID}/RENAME/{NEW_NAME}
* Rename folder name
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.577Z",
"updated_at": "2024-09-23T11:00:41.577Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id
Folder ID
path string new_name path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad input: incorrect new name
404 Cannot find folder
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /FOLDER/{FOLDER_ID}/TRASH
* Move the folder to trash
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.578Z",
"updated_at": "2024-09-23T11:00:41.578Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string check true false query boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Cannot find folder 409 Folder
already in trash
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /FOLDER/{FOLDER_ID}/DOCUMENTS
* Get folder / documents Tree
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.579Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.579Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.579Z"
},
"valid_until": "2024-09-23T11:00:41.579Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.579Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.579Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.579Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.579Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer sort TYPE TITLE FILENAME AUTHOR_NAME CREATION_DATE WAS_READ
LOCATION IS_SHARED SIZE DIGISHOOT CHARGEABLE_AMOUNT
The field on which you want to sort the results
query stringdirection ASCENDING DESCENDING
The direction in which you want to sort the results, for the given field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 At least one parameter is
incorrect (sort, direction, max_results) 404 Cannot find folder
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /FOLDER/{FOLDER_ID}/FAVORITE_STATUS/{FAVORITE_STATUS}
* Set favorite status to folder
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.581Z",
"updated_at": "2024-09-23T11:00:41.581Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string favorite_status true false path boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Cannot find folder
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /FOLDER/{FOLDER_ID}
* Delete the folder
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Cannot find folder 409 Folder
not in trash
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /FOLDER/{FOLDER_ID}/RESTORE
* Move the folder to safe
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.582Z",
"updated_at": "2024-09-23T11:00:41.582Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Cannot find folder 409 Folder
not in trash
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /FOLDER/{FOLDER_ID}/INFO
* Returns folder's size
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FileTreeInfo {
id (string, optional),
name (string, optional),
size (long, optional),
has_health_document (boolean, optional)
}
{
"id": "string",
"name": "string",
"size": 0,
"has_health_document": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Cannot find folder
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /FOLDER/{FOLDER_ID}/MOVE
* Move folder to another one
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.583Z",
"updated_at": "2024-09-23T11:00:41.583Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type folder_id path
string to
The target folder
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Cannot find folder 409 Cannot
move a folder into its child folders or itself
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* FOLDERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /FOLDERS
* Returns the folders tree
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderTreeViewList {
folders (Array[FolderTreeView], optional),
document_count (integer, optional)
}
FolderTreeView {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional),
folders (Array[FolderTreeView], optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"folders": [
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.584Z",
"updated_at": "2024-09-23T11:00:41.584Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0,
"folders": [
"FolderTreeView"
]
}
],
"document_count": 0
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /FOLDERS/TRASH
* Returns the folders tree
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaDataList {
folders (Array[FolderMetaData], optional)
}
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"folders": [
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.585Z",
"updated_at": "2024-09-23T11:00:41.585Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /FOLDERS/FAVORITE
* Returns the favorite folders
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderMetaDataList {
folders (Array[FolderMetaData], optional)
}
FolderMetaData {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"folders": [
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.585Z",
"updated_at": "2024-09-23T11:00:41.585Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /FOLDERS/SAFE
* Returns the folders tree
WARNING: DEPRECATED
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FolderTreeViewList {
folders (Array[FolderTreeView], optional),
document_count (integer, optional)
}
FolderTreeView {
id (string, optional),
name (string, optional),
favorite (boolean, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
location (string, optional) = ['SAFE' or 'TRASH']
locationEnum:"SAFE", "TRASH"
,
sender_name (string, optional),
sender_pid (string, optional),
sender_thumbnail (string, optional),
sender_logo (string, optional),
sender_url_selfcare (string, optional),
senders (Array[SenderForFolderMetaData], optional),
document_count (integer, optional),
folders (Array[FolderTreeView], optional)
}
SenderForFolderMetaData {
name (string, optional),
pid (string, optional),
thumbnail (string, optional),
logo (string, optional),
url_selfcare (string, optional),
membership_field_one (string, optional)
}
{
"folders": [
{
"id": "string",
"name": "string",
"favorite": true,
"created_at": "2024-09-23T11:00:41.586Z",
"updated_at": "2024-09-23T11:00:41.586Z",
"location": "string",
"sender_name": "string",
"sender_pid": "string",
"sender_thumbnail": "string",
"sender_logo": "string",
"sender_url_selfcare": "string",
"senders": [
{
"name": "string",
"pid": "string",
"thumbnail": "string",
"logo": "string",
"url_selfcare": "string",
"membership_field_one": "string"
}
],
"document_count": 0,
"folders": [
"FolderTreeView"
]
}
],
"document_count": 0
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* GOOD
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /GOOD/{GOOD_ID}/DOCUMENT/{DOCUMENT_ID}
* Delete a document from this Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string document_id
The id of a document in the safe
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Document isn't in this Good. 409 Not user's document.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /GOOD/{GOOD_ID}/DOCUMENTS
* Retrieve the documents of a Good
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.587Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.587Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.587Z"
},
"valid_until": "2024-09-23T11:00:41.587Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.587Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.587Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.587Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.587Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow Good ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /GOOD/{GOOD_ID}/PICTURE
* Retrieve the picture of this Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No picture
for this Good 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /GOOD/{GOOD_ID}/PICTURE
* Create the picture of this Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string picture
The picture to upload
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No picture
for this Good 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /GOOD/{GOOD_ID}/PICTURE
* Delete the picture of this Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /GOOD/{GOOD_ID}/PROCEDURE
* Add a procedure to a Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string user_procedure_id
Parameter content type: application/json
The id of a user procedure
body
* Model
* Model Schema
UserProcedureIdInput {
user_procedure_id (string, optional)
}
{
"user_procedure_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Procedure added 403 Not user's
user procedure. 404 User procedure doesn't exist. 409 The user procedure
is already in this Good.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /GOOD/{GOOD_ID}/PROCEDURE/{USER_PROCEDURE_ID}
* Delete a procedure from this Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string user_procedure_id
The id of a user procedure
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403 Not
user's user procedure. 404 User procedure isn't in this Good.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /GOOD/{GOOD_ID}
* Retrieve a Good
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
GoodData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
buy_date (date, optional),
caution_date (date, optional),
type (string, optional) = ['AUTOMOTIVE' or 'FURNISHING' or
'COMPUTER_MULTIMEDIA' or 'TELEPHONY' or 'CLOTH_ACCESORY' or 'JEWELLERY'
or 'HOME' or 'OTHER']
typeEnum:"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY",
"CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"id": "string",
"name": "string",
"picture": true,
"buy_date": "2024-09-23",
"caution_date": "2024-09-23",
"type": "string",
"created_at": "2024-09-23T11:00:41.592Z",
"updated_at": "2024-09-23T11:00:41.592Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow Good
ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /GOOD/{GOOD_ID}
* Update a Good
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
GoodData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
buy_date (date, optional),
caution_date (date, optional),
type (string, optional) = ['AUTOMOTIVE' or 'FURNISHING' or
'COMPUTER_MULTIMEDIA' or 'TELEPHONY' or 'CLOTH_ACCESORY' or 'JEWELLERY'
or 'HOME' or 'OTHER']
typeEnum:"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY",
"CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"id": "string",
"name": "string",
"picture": true,
"buy_date": "2024-09-23",
"caution_date": "2024-09-23",
"type": "string",
"created_at": "2024-09-23T11:00:41.592Z",
"updated_at": "2024-09-23T11:00:41.592Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string good_data
Parameter content type: application/json
The data of the Good
body
* Model
* Model Schema
GoodInput {
name (string, optional),
buy_date (date, optional),
caution_date (date, optional),
type (string) = ['AUTOMOTIVE' or 'FURNISHING' or 'COMPUTER_MULTIMEDIA' or
'TELEPHONY' or 'CLOTH_ACCESORY' or 'JEWELLERY' or 'HOME' or 'OTHER']
typeEnum:"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY",
"CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"
}
{
"name": "string",
"buy_date": "2024-09-23",
"caution_date": "2024-09-23",
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Not a valid Good input. 403
Unknow user. 404 Unknow Good ID. 409 The purchase date is in the future.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /GOOD/{GOOD_ID}
* Delete a Good with this id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow Good
ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /GOOD
* Create a Good
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
GoodData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
buy_date (date, optional),
caution_date (date, optional),
type (string, optional) = ['AUTOMOTIVE' or 'FURNISHING' or
'COMPUTER_MULTIMEDIA' or 'TELEPHONY' or 'CLOTH_ACCESORY' or 'JEWELLERY'
or 'HOME' or 'OTHER']
typeEnum:"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY",
"CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"id": "string",
"name": "string",
"picture": true,
"buy_date": "2024-09-23",
"caution_date": "2024-09-23",
"type": "string",
"created_at": "2024-09-23T11:00:41.595Z",
"updated_at": "2024-09-23T11:00:41.595Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_data
Parameter content type: application/json
The data of the Good
body
* Model
* Model Schema
GoodInput {
name (string, optional),
buy_date (date, optional),
caution_date (date, optional),
type (string) = ['AUTOMOTIVE' or 'FURNISHING' or 'COMPUTER_MULTIMEDIA' or
'TELEPHONY' or 'CLOTH_ACCESORY' or 'JEWELLERY' or 'HOME' or 'OTHER']
typeEnum:"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY",
"CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"
}
{
"name": "string",
"buy_date": "2024-09-23",
"caution_date": "2024-09-23",
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Not a valid Good input. 403
Unknow user. 409 The purchase date is in the future.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /GOOD/{GOOD_ID}/PROCEDURES
* Retrieve the procedures of a Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /GOOD/{GOOD_ID}/TIMELINE
* Retrieve the timeline of a Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer since_id
The returned items should be created after the item whose id is the given
field
query string max_id
The returned items should be created before the item whose id is the
given field
query string type
The type of the returned items
query string status ARCHIVED NOT_ARCHIVED
the object current status
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /GOOD/{GOOD_ID}/DOCUMENT
* Add a document to a Good
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type good_id
The ID of the Good
path string document_id
Parameter content type: application/json
The id of a document in the safe
body
* Model
* Model Schema
DocumentIdInput {
document_id (string, optional)
}
{
"document_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Document added 403 Not user's
document. 404 Document doesn't exist. 409 The document is already in this
Good.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* GOODS
* Show/Hide
* List Operations
* Expand Operations
* * GET /GOODS
* Returns all user's goods
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
GoodDataList {
goods (Array[GoodData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
GoodData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
buy_date (date, optional),
caution_date (date, optional),
type (string, optional) = ['AUTOMOTIVE' or 'FURNISHING' or
'COMPUTER_MULTIMEDIA' or 'TELEPHONY' or 'CLOTH_ACCESORY' or 'JEWELLERY'
or 'HOME' or 'OTHER']
typeEnum:"AUTOMOTIVE", "FURNISHING", "COMPUTER_MULTIMEDIA", "TELEPHONY",
"CLOTH_ACCESORY", "JEWELLERY", "HOME", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"goods": [
{
"id": "string",
"name": "string",
"picture": true,
"buy_date": "2024-09-23",
"caution_date": "2024-09-23",
"type": "string",
"created_at": "2024-09-23T11:00:41.599Z",
"updated_at": "2024-09-23T11:00:41.599Z"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HEALTH
* Show/Hide
* List Operations
* Expand Operations
* * GET /HEALTH/{HEALTH_ID}
* Retrieve a Health
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HealthData {
civility (string, optional) = ['M' or 'MME' or 'DR' or 'PR']
civilityEnum:"M", "MME", "DR", "PR"
,
id (string, optional),
first_name (string, optional),
pro_type (string, optional) = ['GENERAL_PRACTITIONER' or 'DENTIST' or
'NURSE' or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or
'OTHER']
pro_typeEnum:"GENERAL_PRACTITIONER", "DENTIST", "NURSE",
"OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"
,
address (string, optional),
web_site (string, optional),
mail (string, optional),
phone_number (string, optional),
appointment_link (string, optional),
regular_doctor (boolean, optional),
name (string, optional),
picture (boolean, optional),
item_type (string, optional) = ['MEDICAL_PROFESSIONAL' or
'MEDICAL_ANALYSIS_LABORATORY' or 'GENERAL_HEALTH_CARE_SYSTEM' or
'MSA_HEALTH_CARE_SYSTEM' or 'MSI_HEALTH_CARE_SYSTEM' or
'OTHER_HEALTH_CARE_SYSTEM' or 'MUTUAL_HEALTH' or 'OTHER']
item_typeEnum:"MEDICAL_PROFESSIONAL", "MEDICAL_ANALYSIS_LABORATORY",
"GENERAL_HEALTH_CARE_SYSTEM", "MSA_HEALTH_CARE_SYSTEM",
"MSI_HEALTH_CARE_SYSTEM", "OTHER_HEALTH_CARE_SYSTEM", "MUTUAL_HEALTH",
"OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"civility": "string",
"id": "string",
"first_name": "string",
"pro_type": "string",
"address": "string",
"web_site": "string",
"mail": "string",
"phone_number": "string",
"appointment_link": "string",
"regular_doctor": true,
"name": "string",
"picture": true,
"item_type": "string",
"created_at": "2024-09-23T11:00:41.600Z",
"updated_at": "2024-09-23T11:00:41.600Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow Health
ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /HEALTH/{HEALTH_ID}
* Update a Health
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HealthData {
civility (string, optional) = ['M' or 'MME' or 'DR' or 'PR']
civilityEnum:"M", "MME", "DR", "PR"
,
id (string, optional),
first_name (string, optional),
pro_type (string, optional) = ['GENERAL_PRACTITIONER' or 'DENTIST' or
'NURSE' or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or
'OTHER']
pro_typeEnum:"GENERAL_PRACTITIONER", "DENTIST", "NURSE",
"OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"
,
address (string, optional),
web_site (string, optional),
mail (string, optional),
phone_number (string, optional),
appointment_link (string, optional),
regular_doctor (boolean, optional),
name (string, optional),
picture (boolean, optional),
item_type (string, optional) = ['MEDICAL_PROFESSIONAL' or
'MEDICAL_ANALYSIS_LABORATORY' or 'GENERAL_HEALTH_CARE_SYSTEM' or
'MSA_HEALTH_CARE_SYSTEM' or 'MSI_HEALTH_CARE_SYSTEM' or
'OTHER_HEALTH_CARE_SYSTEM' or 'MUTUAL_HEALTH' or 'OTHER']
item_typeEnum:"MEDICAL_PROFESSIONAL", "MEDICAL_ANALYSIS_LABORATORY",
"GENERAL_HEALTH_CARE_SYSTEM", "MSA_HEALTH_CARE_SYSTEM",
"MSI_HEALTH_CARE_SYSTEM", "OTHER_HEALTH_CARE_SYSTEM", "MUTUAL_HEALTH",
"OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"civility": "string",
"id": "string",
"first_name": "string",
"pro_type": "string",
"address": "string",
"web_site": "string",
"mail": "string",
"phone_number": "string",
"appointment_link": "string",
"regular_doctor": true,
"name": "string",
"picture": true,
"item_type": "string",
"created_at": "2024-09-23T11:00:41.601Z",
"updated_at": "2024-09-23T11:00:41.601Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string health_data
Parameter content type: application/json
The data of the Health
body
* Model
* Model Schema
HealthDataInput {
civility (string, optional) = ['M' or 'MME' or 'DR' or 'PR']
civilityEnum:"M", "MME", "DR", "PR"
,
first_name (string, optional),
pro_type (string, optional) = ['GENERAL_PRACTITIONER' or 'DENTIST' or
'NURSE' or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or
'OTHER']
pro_typeEnum:"GENERAL_PRACTITIONER", "DENTIST", "NURSE",
"OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"
,
address (string, optional),
web_site (string, optional),
mail (string, optional),
phone_number (string, optional),
appointment_link (string, optional),
regular_doctor (boolean, optional),
name (string, optional),
photo (boolean, optional)
}
{
"civility": "string",
"first_name": "string",
"pro_type": "string",
"address": "string",
"web_site": "string",
"mail": "string",
"phone_number": "string",
"appointment_link": "string",
"regular_doctor": true,
"name": "string",
"photo": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Not a valid Health input. 403
Unknow user. 404 Unknow Health ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HEALTH/{HEALTH_ID}
* Delete a Health with this id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow Health
ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HEALTH/{HEALTH_ID}/DOCUMENT/{DOCUMENT_ID}
* Delete a document from this health item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string document_id
The id of a document in the safe
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success. 403
Unknow user. 404 Document isn't in this health item. 409 Not user
document.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HEALTH/{HEALTH_ID}/DOCUMENTS
* Retrieve the documents of an item health
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.603Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.603Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.603Z"
},
"valid_until": "2024-09-23T11:00:41.603Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.603Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.603Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.603Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.603Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow Health ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HEALTH/{HEALTH_ID}/PICTURE
* Retrieve the picture of this health item
RESPONSE CLASS (STATUS 200)
Response Content Type images/gif images/png images/jpg
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No avatar in
this health item 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HEALTH/{HEALTH_ID}/PICTURE
* Create the picture of this Health Item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string picture
The picture to upload
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No picture
for this health item 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HEALTH/{HEALTH_ID}/PICTURE
* Delete the picture of this Health Item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HEALTH/{HEALTH_ID}/PROCEDURE
* Add a procedure to a Health Item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string user_procedure_id
Parameter content type: application/json
The id of a user procedure
body
* Model
* Model Schema
UserProcedureIdInput {
user_procedure_id (string, optional)
}
{
"user_procedure_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Procedure added 403 Not user's
user procedure. 404 User procedure doesn't exist. 409 The user procedure
is already in this Health Item.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HEALTH/{HEALTH_ID}/PROCEDURE/{USER_PROCEDURE_ID}
* Delete a procedure from this health item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string user_procedure_id
The id of a user procedure
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success. 403 Not
user's user procedure. 404 User procedure isn't in this health item.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HEALTH
* create health item
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HealthData {
civility (string, optional) = ['M' or 'MME' or 'DR' or 'PR']
civilityEnum:"M", "MME", "DR", "PR"
,
id (string, optional),
first_name (string, optional),
pro_type (string, optional) = ['GENERAL_PRACTITIONER' or 'DENTIST' or
'NURSE' or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or
'OTHER']
pro_typeEnum:"GENERAL_PRACTITIONER", "DENTIST", "NURSE",
"OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"
,
address (string, optional),
web_site (string, optional),
mail (string, optional),
phone_number (string, optional),
appointment_link (string, optional),
regular_doctor (boolean, optional),
name (string, optional),
picture (boolean, optional),
item_type (string, optional) = ['MEDICAL_PROFESSIONAL' or
'MEDICAL_ANALYSIS_LABORATORY' or 'GENERAL_HEALTH_CARE_SYSTEM' or
'MSA_HEALTH_CARE_SYSTEM' or 'MSI_HEALTH_CARE_SYSTEM' or
'OTHER_HEALTH_CARE_SYSTEM' or 'MUTUAL_HEALTH' or 'OTHER']
item_typeEnum:"MEDICAL_PROFESSIONAL", "MEDICAL_ANALYSIS_LABORATORY",
"GENERAL_HEALTH_CARE_SYSTEM", "MSA_HEALTH_CARE_SYSTEM",
"MSI_HEALTH_CARE_SYSTEM", "OTHER_HEALTH_CARE_SYSTEM", "MUTUAL_HEALTH",
"OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"civility": "string",
"id": "string",
"first_name": "string",
"pro_type": "string",
"address": "string",
"web_site": "string",
"mail": "string",
"phone_number": "string",
"appointment_link": "string",
"regular_doctor": true,
"name": "string",
"picture": true,
"item_type": "string",
"created_at": "2024-09-23T11:00:41.608Z",
"updated_at": "2024-09-23T11:00:41.608Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_data
Parameter content type: application/json
The data of the Health
body
* Model
* Model Schema
HealthDataCreate {
civility (string, optional) = ['M' or 'MME' or 'DR' or 'PR']
civilityEnum:"M", "MME", "DR", "PR"
,
first_name (string, optional),
pro_type (string, optional) = ['GENERAL_PRACTITIONER' or 'DENTIST' or
'NURSE' or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or
'OTHER']
pro_typeEnum:"GENERAL_PRACTITIONER", "DENTIST", "NURSE",
"OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"
,
address (string, optional),
web_site (string, optional),
mail (string, optional),
phone_number (string, optional),
appointment_link (string, optional),
regular_doctor (boolean, optional),
name (string, optional),
photo (boolean, optional),
item_type (string) = ['MEDICAL_PROFESSIONAL' or
'MEDICAL_ANALYSIS_LABORATORY' or 'GENERAL_HEALTH_CARE_SYSTEM' or
'MSA_HEALTH_CARE_SYSTEM' or 'MSI_HEALTH_CARE_SYSTEM' or
'OTHER_HEALTH_CARE_SYSTEM' or 'MUTUAL_HEALTH' or 'OTHER']
item_typeEnum:"MEDICAL_PROFESSIONAL", "MEDICAL_ANALYSIS_LABORATORY",
"GENERAL_HEALTH_CARE_SYSTEM", "MSA_HEALTH_CARE_SYSTEM",
"MSI_HEALTH_CARE_SYSTEM", "OTHER_HEALTH_CARE_SYSTEM", "MUTUAL_HEALTH",
"OTHER"
}
{
"civility": "string",
"first_name": "string",
"pro_type": "string",
"address": "string",
"web_site": "string",
"mail": "string",
"phone_number": "string",
"appointment_link": "string",
"regular_doctor": true,
"name": "string",
"photo": true,
"item_type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 the name is required 403
Unknown user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HEALTH/{HEALTH_ID}/PROCEDURES
* Retrieve the procedures of a Health Item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HEALTH/{HEALTH_ID}/DOCUMENT
* Add a document to a Health item
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type health_id
the id of the health item
path string document_id
Parameter content type: application/json
The id of a document in the safe
body
* Model
* Model Schema
DocumentIdInput {
document_id (string, optional)
}
{
"document_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Document added. 403 Not user's
document. 404 Document doesn't exist. 409 The document is already in this
health item.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HEALTHS
* Show/Hide
* List Operations
* Expand Operations
* * GET /HEALTHS
* Returns all user's health items
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HealthDataList {
healths (Array[HealthData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
HealthData {
civility (string, optional) = ['M' or 'MME' or 'DR' or 'PR']
civilityEnum:"M", "MME", "DR", "PR"
,
id (string, optional),
first_name (string, optional),
pro_type (string, optional) = ['GENERAL_PRACTITIONER' or 'DENTIST' or
'NURSE' or 'OPHTHALMOLOGIST' or 'PAEDIATRICIAN' or 'SPECIALIST' or
'OTHER']
pro_typeEnum:"GENERAL_PRACTITIONER", "DENTIST", "NURSE",
"OPHTHALMOLOGIST", "PAEDIATRICIAN", "SPECIALIST", "OTHER"
,
address (string, optional),
web_site (string, optional),
mail (string, optional),
phone_number (string, optional),
appointment_link (string, optional),
regular_doctor (boolean, optional),
name (string, optional),
picture (boolean, optional),
item_type (string, optional) = ['MEDICAL_PROFESSIONAL' or
'MEDICAL_ANALYSIS_LABORATORY' or 'GENERAL_HEALTH_CARE_SYSTEM' or
'MSA_HEALTH_CARE_SYSTEM' or 'MSI_HEALTH_CARE_SYSTEM' or
'OTHER_HEALTH_CARE_SYSTEM' or 'MUTUAL_HEALTH' or 'OTHER']
item_typeEnum:"MEDICAL_PROFESSIONAL", "MEDICAL_ANALYSIS_LABORATORY",
"GENERAL_HEALTH_CARE_SYSTEM", "MSA_HEALTH_CARE_SYSTEM",
"MSI_HEALTH_CARE_SYSTEM", "OTHER_HEALTH_CARE_SYSTEM", "MUTUAL_HEALTH",
"OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"healths": [
{
"civility": "string",
"id": "string",
"first_name": "string",
"pro_type": "string",
"address": "string",
"web_site": "string",
"mail": "string",
"phone_number": "string",
"appointment_link": "string",
"regular_doctor": true,
"name": "string",
"picture": true,
"item_type": "string",
"created_at": "2024-09-23T11:00:41.611Z",
"updated_at": "2024-09-23T11:00:41.611Z"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HOUSING
* Show/Hide
* List Operations
* Expand Operations
* * POST /HOUSING
* Create a Housing Item
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HousingData {
id (string, optional),
label (string, optional),
street_address (string, optional),
extended_address (string, optional),
post_office_box (string, optional),
postal_code (string, optional),
locality (string, optional),
sub_locality (string, optional),
country_code (string, optional),
housing_type (string, optional) = ['MAIN' or 'SECONDARY' or 'VACATION' or
'OTHER']
housing_typeEnum:"MAIN", "SECONDARY", "VACATION", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
verified (boolean, optional)
}
{
"id": "string",
"label": "string",
"street_address": "string",
"extended_address": "string",
"post_office_box": "string",
"postal_code": "string",
"locality": "string",
"sub_locality": "string",
"country_code": "string",
"housing_type": "string",
"created_at": "2024-09-23T11:00:41.612Z",
"updated_at": "2024-09-23T11:00:41.612Z",
"photo": true,
"verified": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_input
Parameter content type: application/json
The housing input data
body
* Model
* Model Schema
HousingInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
label (string, optional),
housing_type (string, optional)
}
{
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"label": "string",
"housing_type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Not a valid Housing input. 403
Unknow user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HOUSING/{HOUSING_ID}/DOCUMENT/{DOCUMENT_ID}
* Delete a document from this house
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string document_id
The id of a document in the safe
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Document isn't in this house. 409 Not user's document.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HOUSING/{HOUSING_ID}/DOCUMENTS
* Retrieve the documents of a house
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.614Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.614Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.614Z"
},
"valid_until": "2024-09-23T11:00:41.614Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.614Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.614Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.614Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.614Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow House ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HOUSING/{HOUSING_ID}/PICTURE
* Retrieve the picture of this house
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No picture
for this House 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HOUSING/{HOUSING_ID}/PICTURE
* Create the picture of this house
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string picture
The picture to upload
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No picture
for this House 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HOUSING/{HOUSING_ID}/PICTURE
* Delete the picture of this House
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HOUSING/{HOUSING_ID}/PROCEDURE
* Add a procedure to housing
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string procedure_id
Parameter content type: application/json
The id of a procedure in the safe
body
* Model
* Model Schema
UserProcedureIdInput {
user_procedure_id (string, optional)
}
{
"user_procedure_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Procedure added 403 Not user's
procedure. 404 Procedure doesn't exist. 409 The procedure is already in
this house.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HOUSING/{HOUSING_ID}/PROCEDURE/{PROCEDURE_ID}
* Delete a procedure from this house
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string procedure_id
The id of a procedure in the safe
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Procedure isn't in this house. 409 Not user's procedure.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HOUSING/{HOUSING_ID}
* Get a housing
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HousingData {
id (string, optional),
label (string, optional),
street_address (string, optional),
extended_address (string, optional),
post_office_box (string, optional),
postal_code (string, optional),
locality (string, optional),
sub_locality (string, optional),
country_code (string, optional),
housing_type (string, optional) = ['MAIN' or 'SECONDARY' or 'VACATION' or
'OTHER']
housing_typeEnum:"MAIN", "SECONDARY", "VACATION", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
verified (boolean, optional)
}
{
"id": "string",
"label": "string",
"street_address": "string",
"extended_address": "string",
"post_office_box": "string",
"postal_code": "string",
"locality": "string",
"sub_locality": "string",
"country_code": "string",
"housing_type": "string",
"created_at": "2024-09-23T11:00:41.618Z",
"updated_at": "2024-09-23T11:00:41.618Z",
"photo": true,
"verified": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Forbidden 404 Housing not
found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /HOUSING/{HOUSING_ID}
* Update a Housing item
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HousingData {
id (string, optional),
label (string, optional),
street_address (string, optional),
extended_address (string, optional),
post_office_box (string, optional),
postal_code (string, optional),
locality (string, optional),
sub_locality (string, optional),
country_code (string, optional),
housing_type (string, optional) = ['MAIN' or 'SECONDARY' or 'VACATION' or
'OTHER']
housing_typeEnum:"MAIN", "SECONDARY", "VACATION", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
verified (boolean, optional)
}
{
"id": "string",
"label": "string",
"street_address": "string",
"extended_address": "string",
"post_office_box": "string",
"postal_code": "string",
"locality": "string",
"sub_locality": "string",
"country_code": "string",
"housing_type": "string",
"created_at": "2024-09-23T11:00:41.619Z",
"updated_at": "2024-09-23T11:00:41.619Z",
"photo": true,
"verified": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string housing_input
Parameter content type: application/json
The housing input data
body
* Model
* Model Schema
HousingInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
label (string, optional),
housing_type (string, optional)
}
{
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"label": "string",
"housing_type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Not a valid Housing input. 403
Unknow user. 404 Unknow Housing ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /HOUSING/{HOUSING_ID}
* Delete a Housing with this id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow
Housing ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HOUSING/{HOUSING_ID}/TIMELINE
* Retrieve the timeline of a housing
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer since_id
The returned items should be created after the item whose id is the given
field
query string max_id
The returned items should be created before the item whose id is the
given field
query string type
The type of the returned items
query string status ARCHIVED NOT_ARCHIVED
the object current status
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /HOUSING/{HOUSING_ID}/PROCEDURES
* Retrieve the procedures of a House
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProcedureList {
user_procedures (Array[UserProcedureData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"user_procedures": [
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.622Z",
"requested_date": "2024-09-23T11:00:41.622Z",
"created_at": "2024-09-23T11:00:41.622Z",
"updated_at": "2024-09-23T11:00:41.622Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /HOUSING/{HOUSING_ID}/DOCUMENT
* Add a document to housing
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type housing_id
The ID of the housing
path string document_id
Parameter content type: application/json
The id of a document in the safe
body
* Model
* Model Schema
DocumentIdInput {
document_id (string, optional)
}
{
"document_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Document added 403 Not user's
document. 404 Document doesn't exist. 409 The document is already in this
house.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* HOUSINGS
* Show/Hide
* List Operations
* Expand Operations
* * GET /HOUSINGS
* Returns all user's housings
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
HousingDataList {
housings (Array[HousingData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
HousingData {
id (string, optional),
label (string, optional),
street_address (string, optional),
extended_address (string, optional),
post_office_box (string, optional),
postal_code (string, optional),
locality (string, optional),
sub_locality (string, optional),
country_code (string, optional),
housing_type (string, optional) = ['MAIN' or 'SECONDARY' or 'VACATION' or
'OTHER']
housing_typeEnum:"MAIN", "SECONDARY", "VACATION", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional),
photo (boolean, optional),
verified (boolean, optional)
}
{
"housings": [
{
"id": "string",
"label": "string",
"street_address": "string",
"extended_address": "string",
"post_office_box": "string",
"postal_code": "string",
"locality": "string",
"sub_locality": "string",
"country_code": "string",
"housing_type": "string",
"created_at": "2024-09-23T11:00:41.625Z",
"updated_at": "2024-09-23T11:00:41.625Z",
"photo": true,
"verified": true
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* I18N
* Show/Hide
* List Operations
* Expand Operations
* * GET /I18N/DEFAULT_LOCALE
* Get default locale
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
StringValue {
value (string, optional)
}
{
"value": "string"
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /I18N
* Get information about i18n on Digiposte
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DigiposteLocaleContext {
locales (Array[Locale], optional),
default_locale (Locale, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
{
"locales": [
{
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
}
],
"default_locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
}
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /I18N/LOCALES
* Get information about locales available on Digiposte
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
StringList {
values (string, optional)
}
{
"values": [
"string"
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* INSCRIPTION
* Show/Hide
* List Operations
* Expand Operations
* * GET /INSCRIPTION/{REGISTRATION_ID}
* Returns the registration data of the given identifier
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Registration {
id (string, optional),
title (string, optional),
user (FullUserAccountInput, optional),
email_quality (string, optional) = ['CHECKED' or 'INFORMATION']
email_qualityEnum:"CHECKED", "INFORMATION"
,
address_quality (string, optional) = ['CHECKED' or 'INFORMATION']
address_qualityEnum:"CHECKED", "INFORMATION"
,
security_plus_form (RegistrationSecurityPlusForm, optional)
}
FullUserAccountInput {
title (string, optional),
user_type (string),
last_name (string)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
email (string, optional),
login (string, optional)
loginReg. Exp.:^[A-Za-z0-9_\-@\.\+]*$
,
siren_siret (string, optional),
company_name (string, optional),
secret_question (string, optional),
secret_question_index (integer, optional),
secret_answer (string, optional),
optin (boolean, optional),
idn_information (IDNInformation, optional),
partner_optin (boolean, optional),
address (AddressInput, optional),
accept_full_dematerialization (boolean, optional),
locale (Locale, optional),
raw_password (string, optional),
valid_secret_question_data (boolean, optional),
valid (boolean, optional)
}
IDNInformation {
prefix (string, optional),
last_name (string, optional),
first_name (string, optional),
birth_date (date, optional),
address (string, optional),
postal_code (string, optional),
city (string, optional),
country (string, optional),
email (string, optional),
idn_information_signature (string, optional),
email_signature (string, optional),
id (string, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
RegistrationSecurityPlusForm {
registration_process (string, optional) = ['ADH' or 'AFF' or 'ASD' or
'ASS']
registration_processEnum:"ADH", "AFF", "ASD", "ASS"
,
sender_meta_data (SenderMetaData, optional),
user_meta_data (UserMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
UserMetaData {
given_name (string, optional),
family_name (string, optional)
}
{
"id": "string",
"title": "string",
"user": {
"title": "string",
"user_type": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"login": "string",
"siren_siret": "string",
"company_name": "string",
"secret_question": "string",
"secret_question_index": 0,
"secret_answer": "string",
"optin": true,
"idn_information": {
"prefix": "string",
"last_name": "string",
"first_name": "string",
"birth_date": "2024-09-23",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"email": "string",
"idn_information_signature": "string",
"email_signature": "string",
"id": "string"
},
"partner_optin": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"accept_full_dematerialization": true,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"raw_password": "string",
"valid_secret_question_data": true,
"valid": true
},
"email_quality": "string",
"address_quality": "string",
"security_plus_form": {
"registration_process": "string",
"sender_meta_data": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"user_meta_data": {
"given_name": "string",
"family_name": "string"
}
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type registration_id
registration id
path string fieldValue1
identification security+ field
query string fieldValue2
authentication security+ field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Registration not match with
security form 404 Registration not found with this id 409 registration
already used or canceld
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /INSCRIPTION
* retrieve registration with url sign and params validity check
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Registration {
id (string, optional),
title (string, optional),
user (FullUserAccountInput, optional),
email_quality (string, optional) = ['CHECKED' or 'INFORMATION']
email_qualityEnum:"CHECKED", "INFORMATION"
,
address_quality (string, optional) = ['CHECKED' or 'INFORMATION']
address_qualityEnum:"CHECKED", "INFORMATION"
,
security_plus_form (RegistrationSecurityPlusForm, optional)
}
FullUserAccountInput {
title (string, optional),
user_type (string),
last_name (string)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
email (string, optional),
login (string, optional)
loginReg. Exp.:^[A-Za-z0-9_\-@\.\+]*$
,
siren_siret (string, optional),
company_name (string, optional),
secret_question (string, optional),
secret_question_index (integer, optional),
secret_answer (string, optional),
optin (boolean, optional),
idn_information (IDNInformation, optional),
partner_optin (boolean, optional),
address (AddressInput, optional),
accept_full_dematerialization (boolean, optional),
locale (Locale, optional),
raw_password (string, optional),
valid_secret_question_data (boolean, optional),
valid (boolean, optional)
}
IDNInformation {
prefix (string, optional),
last_name (string, optional),
first_name (string, optional),
birth_date (date, optional),
address (string, optional),
postal_code (string, optional),
city (string, optional),
country (string, optional),
email (string, optional),
idn_information_signature (string, optional),
email_signature (string, optional),
id (string, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
RegistrationSecurityPlusForm {
registration_process (string, optional) = ['ADH' or 'AFF' or 'ASD' or
'ASS']
registration_processEnum:"ADH", "AFF", "ASD", "ASS"
,
sender_meta_data (SenderMetaData, optional),
user_meta_data (UserMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
UserMetaData {
given_name (string, optional),
family_name (string, optional)
}
{
"id": "string",
"title": "string",
"user": {
"title": "string",
"user_type": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"login": "string",
"siren_siret": "string",
"company_name": "string",
"secret_question": "string",
"secret_question_index": 0,
"secret_answer": "string",
"optin": true,
"idn_information": {
"prefix": "string",
"last_name": "string",
"first_name": "string",
"birth_date": "2024-09-23",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"email": "string",
"idn_information_signature": "string",
"email_signature": "string",
"id": "string"
},
"partner_optin": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"accept_full_dematerialization": true,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"raw_password": "string",
"valid_secret_question_data": true,
"valid": true
},
"email_quality": "string",
"address_quality": "string",
"security_plus_form": {
"registration_process": "string",
"sender_meta_data": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"user_meta_data": {
"given_name": "string",
"family_name": "string"
}
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type senderPid
the sender pid
query string fieldValue1
identification security+ field
query string fieldValue2
authentication security+ field
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 registration not found for
this sender and this securityForm 409 Registration already used or
canceled
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /INSCRIPTION/{REGISTRATION_ID}/REFUSE
* notify that the user have refused the registration
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type registration_id
Identifiant de la pré-inscription
path string body
Parameter content type: application/json
email
body
* Model
* Model Schema
MailInput {
email (string, optional)
}
{
"email": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Registration not found with
this id 409 Registration already used or canceled
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * HEAD /INSCRIPTION/DOCUMENTS
* Returns number of documents based on fieldOne and senderCode
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type fieldOne (empty)
fieldOne
query string senderCode (empty)
senderCode
query string registrationId (empty)
registrationId
query string
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* JOB
* Show/Hide
* List Operations
* Expand Operations
* * DELETE /JOB/{EMPLOYER_ID}/DOCUMENT/{DOCUMENT_ID}
* Delete a document from this job
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string document_id
The id of a document in the safe
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success. 403
Unknow user. 404 Document isn't in this job. 409 Not user document.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /JOB/{EMPLOYER_ID}/DOCUMENTS
* Retrieve the documents of a Job
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.638Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.638Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.638Z"
},
"valid_until": "2024-09-23T11:00:41.638Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.638Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.638Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.638Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.638Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow Job ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /JOB/{EMPLOYER_ID}/PICTURE
* Retrieve the picture of this Employer
RESPONSE CLASS (STATUS 200)
Response Content Type images/gif images/png images/jpg
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No avatar in
this Employer 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /JOB/{EMPLOYER_ID}/PICTURE
* Create the picture of this Employer
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string picture
The picture to upload
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 No picture
for this employer 500 Fail
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /JOB/{EMPLOYER_ID}/PICTURE
* Delete the picture of this Employer
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403
Unknow user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /JOB
* create a job
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
EmployerData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
begin_date (date, optional),
end_date (date, optional),
position (string, optional),
current_position (boolean, optional),
type (string, optional) = ['PROFESSION' or 'APPRENTICESHIP' or
'RETIREMENT' or 'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP' or 'OTHER']
typeEnum:"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING",
"VOLUNTEER", "INTERNSHIP", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"id": "string",
"name": "string",
"picture": true,
"begin_date": "2024-09-23",
"end_date": "2024-09-23",
"position": "string",
"current_position": true,
"type": "string",
"created_at": "2024-09-23T11:00:41.643Z",
"updated_at": "2024-09-23T11:00:41.643Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_data
Parameter content type: application/json
The data of the Employer
body
* Model
* Model Schema
EmployerDataInput {
name (string, optional),
begin_date (date, optional),
end_date (date, optional),
position (string, optional),
current_position (boolean, optional),
type (string) = ['PROFESSION' or 'APPRENTICESHIP' or 'RETIREMENT' or
'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP' or 'OTHER']
typeEnum:"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING",
"VOLUNTEER", "INTERNSHIP", "OTHER"
}
{
"name": "string",
"begin_date": "2024-09-23",
"end_date": "2024-09-23",
"position": "string",
"current_position": true,
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The end date must be after the
begin date 403 Unknow user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /JOB/{EMPLOYER_ID}/PROCEDURE
* Add a procedure to a Job
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string user_procedure_id
Parameter content type: application/json
The id of a user procedure
body
* Model
* Model Schema
UserProcedureIdInput {
user_procedure_id (string, optional)
}
{
"user_procedure_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Procedure added 403 Not user's
user procedure. 404 User procedure doesn't exist. 409 The user procedure
is already in this Job.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /JOB/{EMPLOYER_ID}/PROCEDURE/{USER_PROCEDURE_ID}
* Delete a procedure from this Job
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string user_procedure_id
The id of a user procedure
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted with success 403 Not
user's user procedure. 404 User procedure isn't in this Job.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /JOB/{EMPLOYER_ID}
* Retrieve a Employer
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
EmployerData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
begin_date (date, optional),
end_date (date, optional),
position (string, optional),
current_position (boolean, optional),
type (string, optional) = ['PROFESSION' or 'APPRENTICESHIP' or
'RETIREMENT' or 'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP' or 'OTHER']
typeEnum:"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING",
"VOLUNTEER", "INTERNSHIP", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"id": "string",
"name": "string",
"picture": true,
"begin_date": "2024-09-23",
"end_date": "2024-09-23",
"position": "string",
"current_position": true,
"type": "string",
"created_at": "2024-09-23T11:00:41.648Z",
"updated_at": "2024-09-23T11:00:41.648Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow
Employer ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /JOB/{EMPLOYER_ID}
* Update a job
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
EmployerData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
begin_date (date, optional),
end_date (date, optional),
position (string, optional),
current_position (boolean, optional),
type (string, optional) = ['PROFESSION' or 'APPRENTICESHIP' or
'RETIREMENT' or 'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP' or 'OTHER']
typeEnum:"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING",
"VOLUNTEER", "INTERNSHIP", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"id": "string",
"name": "string",
"picture": true,
"begin_date": "2024-09-23",
"end_date": "2024-09-23",
"position": "string",
"current_position": true,
"type": "string",
"created_at": "2024-09-23T11:00:41.649Z",
"updated_at": "2024-09-23T11:00:41.649Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string employer_data
Parameter content type: application/json
The data of the Employer
body
* Model
* Model Schema
EmployerDataInput {
name (string, optional),
begin_date (date, optional),
end_date (date, optional),
position (string, optional),
current_position (boolean, optional),
type (string) = ['PROFESSION' or 'APPRENTICESHIP' or 'RETIREMENT' or
'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP' or 'OTHER']
typeEnum:"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING",
"VOLUNTEER", "INTERNSHIP", "OTHER"
}
{
"name": "string",
"begin_date": "2024-09-23",
"end_date": "2024-09-23",
"position": "string",
"current_position": true,
"type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Not a valid Employer input.
403 Unknow user. 404 Unknow Employer ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /JOB/{EMPLOYER_ID}
* Delete a job
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Unknow user. 404 Unknow
Employer ID.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /JOB/{EMPLOYER_ID}/PROCEDURES
* Retrieve the procedures of a Job
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user. 404 Unknow ID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /JOB/{EMPLOYER_ID}/DOCUMENT
* Add a document to a Job
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type employer_id
the id of the employer
path string document_id
Parameter content type: application/json
The id of a document in the safe
body
* Model
* Model Schema
DocumentIdInput {
document_id (string, optional)
}
{
"document_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Document added 403 Not user's
document. 404 Document doesn't exist. 409 The document is already in this
Job.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* JOBS
* Show/Hide
* List Operations
* Expand Operations
* * GET /JOBS
* Returns all user's employers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
EmployerDataList {
employers (Array[EmployerData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
EmployerData {
id (string, optional),
name (string, optional),
picture (boolean, optional),
begin_date (date, optional),
end_date (date, optional),
position (string, optional),
current_position (boolean, optional),
type (string, optional) = ['PROFESSION' or 'APPRENTICESHIP' or
'RETIREMENT' or 'SCHOOLING' or 'VOLUNTEER' or 'INTERNSHIP' or 'OTHER']
typeEnum:"PROFESSION", "APPRENTICESHIP", "RETIREMENT", "SCHOOLING",
"VOLUNTEER", "INTERNSHIP", "OTHER"
,
created_at (date-time, optional),
updated_at (date-time, optional)
}
{
"employers": [
{
"id": "string",
"name": "string",
"picture": true,
"begin_date": "2024-09-23",
"end_date": "2024-09-23",
"position": "string",
"current_position": true,
"type": "string",
"created_at": "2024-09-23T11:00:41.653Z",
"updated_at": "2024-09-23T11:00:41.653Z"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination. 403 Unknow
user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* JWTDOCUMENT
* Show/Hide
* List Operations
* Expand Operations
* * POST /JWT/DOCUMENT
* Upload a document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.654Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.654Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.654Z"
},
"valid_until": "2024-09-23T11:00:41.654Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.654Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.654Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.654Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.654Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type title
Parameter content type: multipart/form-data
The title of the document
body string hash
Parameter content type: multipart/form-data
The hash value of the document content
body string algo
Parameter content type: multipart/form-data
The hash algorithm to check the hash
body string folder_id
Parameter content type: multipart/form-data
Folder ID where the document will be stored
body string archive_size
Parameter content type: multipart/form-data
Size of the archive
body long X-AuthorizeSender true false header booleanarchive
The file to archive
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 The document hash is wrong 413 The document to upload is too large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /JWT/DOCUMENT/{DOCUMENTID}/METADATA
* Returns metadata of documents included in documents id array
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ChooserMetadata {
document_id (string, optional),
filename (string, optional),
size (integer, optional),
health (boolean, optional),
type (string, optional),
sender_id (string, optional),
sender_name (string, optional),
certified (boolean, optional),
mimetype (string, optional),
created_at (date-time, optional),
published_at (date-time, optional),
document_type (string, optional) = ['COLLECTED' or 'API_COLLECTED' or
'MANUAL' or 'ROUTED']
document_typeEnum:"COLLECTED", "API_COLLECTED", "MANUAL", "ROUTED"
,
folder_id (string, optional),
folder_path (string, optional)
}
{
"document_id": "string",
"filename": "string",
"size": 0,
"health": true,
"type": "string",
"sender_id": "string",
"sender_name": "string",
"certified": true,
"mimetype": "string",
"created_at": "2024-09-23T11:00:41.656Z",
"published_at": "2024-09-23T11:00:41.656Z",
"document_type": "string",
"folder_id": "string",
"folder_path": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type documentId path
string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad request
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* LEGATOR
* Show/Hide
* List Operations
* Expand Operations
* * GET /LEGATOR/{ID}
* Get current user's legator by id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The requested legator does not
exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* LEGATORS
* Show/Hide
* List Operations
* Expand Operations
* * GET /LEGATORS
* Get the legators of the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LegatorsData {
legators (Array[Legator], optional)
}
Legator {
id (string, optional),
given_name (string, optional),
family_name (string, optional),
login (string, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
trusted_contact_id (string, optional)
}
{
"legators": [
{
"id": "string",
"given_name": "string",
"family_name": "string",
"login": "string",
"status": "string",
"trusted_contact_id": "string"
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MEMBERSHIP
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERSHIP/OPTOUT/AVAILABILITY
* Check field one availability by sender
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipOptoutFieldOneValidation {
sender_pid (string, optional),
field_one (string, optional),
available (boolean, optional)
}
{
"sender_pid": "string",
"field_one": "string",
"available": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type sender_pid
Sender pid
query string field_one
Field one
query string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERSHIP/OPTOUTS/AVAILABILITY
* Check field one availability by sender for multiple optouts
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipOptoutFieldOneValidation {
sender_pid (string, optional),
field_one (string, optional),
available (boolean, optional)
}
{
"sender_pid": "string",
"field_one": "string",
"available": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type sender_pid
Sender pid
query string body
Parameter content type: application/json
body Array[string]
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERSHIP/OPTOUT
* Create an optout
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipOptoutOutput {
route_code (string, optional),
purl (string, optional)
}
{
"route_code": "string",
"purl": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MembershipOptoutInput {
partner_user_id (string)
partner_user_idReg. Exp.:[-_\.\sa-zA-Z0-9]{1,255}
,
secret_code (string, optional)
secret_codeReg. Exp.:[-_a-zA-Z0-9]{1,255}
,
title (string, optional),
firstname (string, optional)
firstnameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
lastname (string, optional)
lastnameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
email (string, optional),
send_mail (boolean, optional)
}
{
"partner_user_id": "string",
"secret_code": "string",
"title": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"send_mail": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERSHIP/OPTIN
* Create an optin
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipOptinOutput {
registration_code (string, optional),
account_code (string, optional),
route_code (string, optional),
purl (string, optional),
status (string, optional),
code (string, optional),
message (string, optional),
status_code (string, optional),
pid (string, optional)
}
{
"registration_code": "string",
"account_code": "string",
"route_code": "string",
"purl": "string",
"status": "string",
"code": "string",
"message": "string",
"status_code": "string",
"pid": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MembershipOptinInput {
partner_user_id (string)
partner_user_idReg. Exp.:[-_a-zA-Z0-9]{1,255}
,
secret_code (string, optional)
secret_codeReg. Exp.:[-_a-zA-Z0-9]{1,255}
,
title (string, optional),
firstname (string, optional)
firstnameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
lastname (string, optional)
lastnameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
email (string, optional),
send_mail (boolean, optional)
}
{
"partner_user_id": "string",
"secret_code": "string",
"title": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"send_mail": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERSHIP
* Join a membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.660Z",
"membership_date": "2024-09-23T11:00:41.660Z",
"request_date": "2024-09-23T11:00:41.660Z",
"cancellation_date": "2024-09-23T11:00:41.660Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.660Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.660Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.660Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.660Z"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MembershipInput {
address (MembershipAddress, optional),
field1_value (string, optional),
field2_value (string, optional),
sender_pid (string),
folder_id (string, optional)
}
MembershipAddress {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
{
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"field1_value": "string",
"field2_value": "string",
"sender_pid": "string",
"folder_id": "string"
}
Click to set as parameter value
registrationId query string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERSHIP/AVAILABLE
* Check if the membership is available
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type input query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Incorrect parameter 404 The
membership isn't available
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERSHIP/VALIDATE
* Acquit a membership
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partner_id
PartnerId (senderCode)
query string partner_user_id
UserId from partner (fieldone)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 All parameters are required
404 Partner not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MEMBERSHIPID
* Show/Hide
* List Operations
* Expand Operations
* * PUT /MEMBERSHIP/{ID}/INBOX_FOLDER
* Reset retriever data
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.663Z",
"membership_date": "2024-09-23T11:00:41.663Z",
"request_date": "2024-09-23T11:00:41.663Z",
"cancellation_date": "2024-09-23T11:00:41.663Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.663Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.663Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.663Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.663Z"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
ID of membership
path string value
Folder ID
query string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /MEMBERSHIP/{ID}/ALIAS
* Update a membership alias
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.664Z",
"membership_date": "2024-09-23T11:00:41.664Z",
"request_date": "2024-09-23T11:00:41.664Z",
"cancellation_date": "2024-09-23T11:00:41.664Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.664Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.664Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.664Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.664Z"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
ID of membership
path string alias
Parameter content type: application/json
Alias of membership
body
* Model
* Model Schema
MembershipAliasInput {
alias (string, optional)
}
{
"alias": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The alias is not valid
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /MEMBERSHIP/{ID}/NOTE
* Update a membership note
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.666Z",
"membership_date": "2024-09-23T11:00:41.666Z",
"request_date": "2024-09-23T11:00:41.666Z",
"cancellation_date": "2024-09-23T11:00:41.666Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.666Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.666Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.666Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.666Z"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
Membership Id
path string note
Parameter content type: application/json
Membership note
body
* Model
* Model Schema
MembershipNoteInput {
note (string, optional)
}
{
"note": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Note is not valid (empty or
more than 500 characters)
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERSHIP/{ID}
* Retrieve a membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.667Z",
"membership_date": "2024-09-23T11:00:41.667Z",
"request_date": "2024-09-23T11:00:41.667Z",
"cancellation_date": "2024-09-23T11:00:41.667Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.667Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.667Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.667Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.667Z"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
ID of membership
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Membership doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /MEMBERSHIP/{ID}
* Cancel a membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.668Z",
"membership_date": "2024-09-23T11:00:41.668Z",
"request_date": "2024-09-23T11:00:41.668Z",
"cancellation_date": "2024-09-23T11:00:41.668Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.668Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.668Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.668Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.668Z"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
ID of membership
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 Can delete collected
membership only if sender allow it
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERSHIP/{ID}/STATE
* Retrieve a collected membership transaction state
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CollectedTransactionStateData {
state (string, optional) = ['PENDING' or 'WAIT_2FA' or 'VALID' or
'INVALID_CREDENTIALS' or 'INVALID_DATA' or 'CHECK_ACCOUNT' or
'DEMATERIALISATION_NEEDED' or 'BAD_2FA' or 'ERROR']
stateEnum:"PENDING", "WAIT_2FA", "VALID", "INVALID_CREDENTIALS",
"INVALID_DATA", "CHECK_ACCOUNT", "DEMATERIALISATION_NEEDED", "BAD_2FA",
"ERROR"
,
sub_state (string, optional) = ['OTP' or 'STRONG_AUTH']
sub_stateEnum:"OTP", "STRONG_AUTH"
,
wait_for_user_label (string, optional)
}
{
"state": "string",
"sub_state": "string",
"wait_for_user_label": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
ID of membership
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Membership doesn't exist 409
Membership is not collected membership 410 TransactionId expired 501
unknown transaction state
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* MEMBERSHIPS
* Show/Hide
* List Operations
* Expand Operations
* * GET /MEMBERSHIPS/{ID}/DOCUMENTS
* Retrieve membership documents data
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentPartnerDataList {
documents (Array[DocumentPartnerData], optional),
count (integer, optional)
}
DocumentPartnerData {
id (string, optional),
title (string, optional),
type (string, optional),
creation_date (date-time, optional),
size (integer, optional)
}
{
"documents": [
{
"id": "string",
"title": "string",
"type": "string",
"creation_date": "2024-09-23T11:00:41.671Z",
"size": 0
}
],
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id
ID of membership
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad membership statusLabel.
404 Membership doesn't exist or not accesible.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /MEMBERSHIPS/STATE
* Retrieve collected membership transaction states
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CollectedTransactionStateMap {
transactions (object, optional)
}
{
"transactions": {}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
MembershipIdsInput {
ids (string, optional)
}
{
"ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Incorrect parameter 501
unknown transaction state 503 service unavailable
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERSHIPS
* Retrieves all user's membership
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipList {
memberships (Array[MembershipMetaData], optional)
}
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"memberships": [
{
"id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
},
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.674Z",
"membership_date": "2024-09-23T11:00:41.674Z",
"request_date": "2024-09-23T11:00:41.674Z",
"cancellation_date": "2024-09-23T11:00:41.674Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.674Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.674Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.674Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.674Z"
}
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type status
the object current status
query string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERSHIPS/SEARCH
* search for memberships with PID and eventually other criteria
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partner_id
PartnerId (senderCode)
query string status_label
the object current status
query string min_updated_at
The minimum date of last update
query string max_updated_at
The maximum date of last update
query string route_code
route code
query string partner_user_id
UserId from partner (fieldone)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 min_updated_at can't be after
min_updated_at 403 forbidden 404 Sender not found with partner_id =
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /MEMBERSHIPS/INFOS
* Get memberships infos
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
MembershipInfosList {
memberships (Array[MembershipInfosDto], optional)
}
MembershipInfosDto {
route_code (string, optional),
partner_user_id (string, optional),
secret_code (string, optional),
civility (string, optional),
lastname (string, optional),
firstname (string, optional),
email (string, optional),
is_personalized (boolean, optional),
purl (string, optional),
updated_at (string, optional),
status (string, optional)
}
{
"memberships": [
{
"route_code": "string",
"partner_user_id": "string",
"secret_code": "string",
"civility": "string",
"lastname": "string",
"firstname": "string",
"email": "string",
"is_personalized": true,
"purl": "string",
"updated_at": "string",
"status": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partner_id
PartnerId (senderCode)
query string partner_user_id
UserId from partner (fieldone)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Functional object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* NOTIFICATION
* Show/Hide
* List Operations
* Expand Operations
* * PUT /NOTIFICATION/{NOTIFICATION_ID}
* Update the notification
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
Notification {
id (string, optional),
type (string, optional) = ['MODIFIED_PROCEDURE' or 'VALIDATED_PROCEDURE'
or 'REJECTED_PROCEDURE' or 'ADDED_DOCUMENT_IN_PROCEDURE' or
'VALIDATED_TRUSTED_CONTACT_REQUEST' or 'VALIDATED_TRUSTED_CONTACT' or
'REFUSED_TRUSTED_CONTACT']
typeEnum:"MODIFIED_PROCEDURE", "VALIDATED_PROCEDURE",
"REJECTED_PROCEDURE", "ADDED_DOCUMENT_IN_PROCEDURE",
"VALIDATED_TRUSTED_CONTACT_REQUEST", "VALIDATED_TRUSTED_CONTACT",
"REFUSED_TRUSTED_CONTACT"
,
read (boolean, optional),
date (date-time, optional),
document (DocumentNotification, optional),
procedure (ProcedureNotification, optional),
user (UserNotification, optional),
partner (PartnerData, optional)
}
DocumentNotification {
id (string, optional),
title (string, optional)
}
ProcedureNotification {
id (string, optional),
name (string, optional)
}
UserNotification {
id (string, optional),
given_name (string, optional),
family_name (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
{
"id": "string",
"type": "string",
"read": true,
"date": "2024-09-23T11:00:41.680Z",
"document": {
"id": "string",
"title": "string"
},
"procedure": {
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"given_name": "string",
"family_name": "string"
},
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type notification_id
ID of user notification
path string body
Parameter content type: application/json
new notification data
body
* Model
* Model Schema
NotificationInput {
read (boolean)
}
{
"read": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* NOTIFICATIONS
* Show/Hide
* List Operations
* Expand Operations
* * GET /NOTIFICATIONS
* Get the notifications the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
NotificationList {
notifications (Array[Notification], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
Notification {
id (string, optional),
type (string, optional) = ['MODIFIED_PROCEDURE' or 'VALIDATED_PROCEDURE'
or 'REJECTED_PROCEDURE' or 'ADDED_DOCUMENT_IN_PROCEDURE' or
'VALIDATED_TRUSTED_CONTACT_REQUEST' or 'VALIDATED_TRUSTED_CONTACT' or
'REFUSED_TRUSTED_CONTACT']
typeEnum:"MODIFIED_PROCEDURE", "VALIDATED_PROCEDURE",
"REJECTED_PROCEDURE", "ADDED_DOCUMENT_IN_PROCEDURE",
"VALIDATED_TRUSTED_CONTACT_REQUEST", "VALIDATED_TRUSTED_CONTACT",
"REFUSED_TRUSTED_CONTACT"
,
read (boolean, optional),
date (date-time, optional),
document (DocumentNotification, optional),
procedure (ProcedureNotification, optional),
user (UserNotification, optional),
partner (PartnerData, optional)
}
DocumentNotification {
id (string, optional),
title (string, optional)
}
ProcedureNotification {
id (string, optional),
name (string, optional)
}
UserNotification {
id (string, optional),
given_name (string, optional),
family_name (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
{
"notifications": [
{
"id": "string",
"type": "string",
"read": true,
"date": "2024-09-23T11:00:41.682Z",
"document": {
"id": "string",
"title": "string"
},
"procedure": {
"id": "string",
"name": "string"
},
"user": {
"id": "string",
"given_name": "string",
"family_name": "string"
},
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
}
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer type
The type of the returned items
query string read true false
To filter by read status
query boolean
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* OFFERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /OFFERS
* Retrieve subscription offers
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
OfferList {
offers (Array[OfferMetaData], optional)
}
OfferMetaData {
pid (string, optional),
basic (boolean, optional),
characteristics (Array[OfferCharacteristicMetaData], optional)
}
OfferCharacteristicMetaData {
type (string, optional),
value (long, optional)
}
{
"offers": [
{
"pid": "string",
"basic": true,
"characteristics": [
{
"type": "string",
"value": 0
}
]
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ONBOARDINGS
* Show/Hide
* List Operations
* Expand Operations
* * GET /ONBOARDINGS/{PID}
* Retrieve all onboardings for the connected user
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type pid path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 unknow onboarding pid 404 You
are trying to get the current user but there is no current user related
to this request! 500 json generation failed
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /ONBOARDINGS/CHECK
*
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type input
Parameter content type: application/json
the onboarding pid
body
* Model
* Model Schema
OnboardingDTO {
onboarding_pid (string)
}
{
"onboarding_pid": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 onboarding pid may not be null
404 You are trying to get the current user but there is no current user
related to this request! 500 json generation failed
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /ONBOARDINGS
* Retrieve all onboardings for the connected user
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 You are trying to get the
current user but there is no current user related to this request!
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PARTNER
* Show/Hide
* List Operations
* Expand Operations
* * POST /PARTNER/DOCUMENT
* Upload a document
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CertifiedDocumentOutput {
document (CertifiedDocumentOutputWrapped, optional)
}
CertifiedDocumentOutputWrapped {
document_id (string, optional),
type (string, optional),
title (string, optional),
file_name (string, optional),
archive_duration (string, optional),
author_tags (string, optional),
hash (string, optional),
algo (string, optional),
file_size (string, optional),
id_routage (string, optional)
}
{
"document": {
"document_id": "string",
"type": "string",
"title": "string",
"file_name": "string",
"archive_duration": "string",
"author_tags": "string",
"hash": "string",
"algo": "string",
"file_size": "string",
"id_routage": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: multipart/form-data
body Attachment title
Parameter content type: multipart/form-data
The title of the document.
body string file_name
Parameter content type: multipart/form-data
The name of the document.
body string archive_duration
Parameter content type: multipart/form-data
The end date of legal archiving.
body string author_tags
Parameter content type: multipart/form-data
The sender tags. Separated by '|' or ','.
body string hash
Parameter content type: multipart/form-data
The hash value of the document content.
body string algo
Parameter content type: multipart/form-data
The hash algorithm to check the hash.
body string file_size
Parameter content type: multipart/form-data
Size of the file.
body string archive
archive
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 The document to upload is empty 413 The document to upload is too
large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PARTNER/{CLIENT_ID}
* get a partner by client_id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PartnerInput {
partner (PartnerDto),
oauth (PartnerOauthDto)
}
PartnerDto {
application (string)
applicationReg. Exp.:[[\p{L}][\p{M}][\p{N}]_\- ]+
,
description (string),
authorization_description (string),
logo_url (string, optional),
email (string, optional)
}
PartnerOauthDto {
callback_urls (string),
enabled (boolean),
refresh_token_validity (integer, optional),
access_token_validity (integer, optional),
workflows (string)
}
{
"partner": {
"application": "string",
"description": "string",
"authorization_description": "string",
"logo_url": "string",
"email": "string"
},
"oauth": {
"callback_urls": [
"string"
],
"enabled": true,
"refresh_token_validity": 0,
"access_token_validity": 0,
"workflows": [
"string"
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type client_id
client id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Données en entrée incorrectes
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PARTNER/{CLIENT_ID}
* update a Partner
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PartnerInput {
partner (PartnerDto),
oauth (PartnerOauthDto)
}
PartnerDto {
application (string)
applicationReg. Exp.:[[\p{L}][\p{M}][\p{N}]_\- ]+
,
description (string),
authorization_description (string),
logo_url (string, optional),
email (string, optional)
}
PartnerOauthDto {
callback_urls (string),
enabled (boolean),
refresh_token_validity (integer, optional),
access_token_validity (integer, optional),
workflows (string)
}
{
"partner": {
"application": "string",
"description": "string",
"authorization_description": "string",
"logo_url": "string",
"email": "string"
},
"oauth": {
"callback_urls": [
"string"
],
"enabled": true,
"refresh_token_validity": 0,
"access_token_validity": 0,
"workflows": [
"string"
]
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type client_id
client id
path string body
Parameter content type: application/json
update partner
body
* Model
* Model Schema
PartnerInput {
partner (PartnerDto),
oauth (PartnerOauthDto)
}
PartnerDto {
application (string)
applicationReg. Exp.:[[\p{L}][\p{M}][\p{N}]_\- ]+
,
description (string),
authorization_description (string),
logo_url (string, optional),
email (string, optional)
}
PartnerOauthDto {
callback_urls (string),
enabled (boolean),
refresh_token_validity (integer, optional),
access_token_validity (integer, optional),
workflows (string)
}
{
"partner": {
"application": "string",
"description": "string",
"authorization_description": "string",
"logo_url": "string",
"email": "string"
},
"oauth": {
"callback_urls": [
"string"
],
"enabled": true,
"refresh_token_validity": 0,
"access_token_validity": 0,
"workflows": [
"string"
]
}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Données en entrée incorrectes
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PARTNER
* Create a Partner
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PartnerSimpleDto {
client_id (string, optional),
client_secret (string, optional)
}
{
"client_id": "string",
"client_secret": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add partner
body
* Model
* Model Schema
PartnerInput {
partner (PartnerDto),
oauth (PartnerOauthDto)
}
PartnerDto {
application (string)
applicationReg. Exp.:[[\p{L}][\p{M}][\p{N}]_\- ]+
,
description (string),
authorization_description (string),
logo_url (string, optional),
email (string, optional)
}
PartnerOauthDto {
callback_urls (string),
enabled (boolean),
refresh_token_validity (integer, optional),
access_token_validity (integer, optional),
workflows (string)
}
{
"partner": {
"application": "string",
"description": "string",
"authorization_description": "string",
"logo_url": "string",
"email": "string"
},
"oauth": {
"callback_urls": [
"string"
],
"enabled": true,
"refresh_token_validity": 0,
"access_token_validity": 0,
"workflows": [
"string"
]
}
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Données en entrée incorrectes
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PARTNER/{CLIENT_ID}/RIGHTS
* Update partner rights
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ApiAccessDto {
http_method (string),
resource (string),
operation (string)
}
{
"http_method": "string",
"resource": "string",
"operation": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type client_id
client id
path string body
Parameter content type: application/json
update partner rights
body
* Model
* Model Schema
PartnerApiAccessInput {
api_access (Array[ApiAccessDto])
}
ApiAccessDto {
http_method (string),
resource (string),
operation (string)
}
{
"api_access": [
{
"http_method": "string",
"resource": "string",
"operation": "string"
}
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Le partenaire n'existe pas 412
La ressource demandée (verbe HTTP + ressource API) n'existe pas
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PARTNER/{CLIENT_ID}/CLIENT-SECRET
* update Partner client secret
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type client_id
client id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Le partenaire n'existe pas
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PARTNER/OFFER/CHANGE
* Change partner offer
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Partner offer
body
* Model
* Model Schema
ChangeOfferInput {
partner_user_id (string, optional),
platform (string, optional),
to_product_id (string, optional)
}
{
"partner_user_id": "string",
"platform": "string",
"to_product_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 The offer has been changed 400
Wrong or missing mandatory parameters 404 Unknown partner_user_id,
platform and/or product_id
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PARTNER/OFFER/CANCEL
* Cancel a partner offer
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Partner offer
body
* Model
* Model Schema
CancelPartnerOfferInput {
partner_user_id (string, optional),
platform (string, optional),
product_id (string, optional)
}
{
"partner_user_id": "string",
"platform": "string",
"product_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 The offer has been canceled
400 Wrong or missing mandatory parameters 404 Unknown partner_user_id,
platform and/or product_id
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PARTNER_PROCEDURE
* Show/Hide
* List Operations
* Expand Operations
* * GET /PARTNER/PROCEDURE/{USER_PROCEDURE_ID}/DOCUMENTS
* Returns all documents of a user procedure in a zip file
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET
/PARTNER/PROCEDURE/{USER_PROCEDURE_ID}/DOCUMENT/{DOCUMENT_ID}/METADATA
* Returns document infos of a user procedure
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string document_id
document id
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PARTNER/PROCEDURE/{USER_PROCEDURE_ID}/QUALIFY
* Returns document of a user procedure
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string qualify_procedure_input
Parameter content type: application/json
qualification parameters
body
* Model
* Model Schema
QualifyProcedureInput {
status (string) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or 'COMPLETED'
or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
refused_documents (Array[RefusedDocument], optional)
}
RefusedDocument {
document_id (string, optional),
refusal_ground (string, optional)
}
{
"status": "string",
"refusal_ground": "string",
"refused_documents": [
{
"document_id": "string",
"refusal_ground": "string"
}
]
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PARTNER/PROCEDURE/{USER_PROCEDURE_ID}/DOCUMENT/{DOCUMENT_ID}
* Returns document of a user procedure
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string document_id
document id
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PARTNER/PROCEDURE/{PROCEDURE_PID}/ASSIGN
* Assign a procedure to a user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
LightUserProcedureData {
id (string, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
name (string, optional)
}
{
"id": "string",
"type": "string",
"name": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type procedure_pid
procedure pid
path string X-OrganismUserId header string X-OrganismId header string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PARTNER_PROCEDURES
* Show/Hide
* List Operations
* Expand Operations
* * GET /PARTNER/PROCEDURES/{PROCEDURE_PID}/DETAILS
* Retrieve an user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.697Z",
"requested_date": "2024-09-23T11:00:41.697Z",
"created_at": "2024-09-23T11:00:41.697Z",
"updated_at": "2024-09-23T11:00:41.697Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type procedure_pid
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PARTNER/PROCEDURES/{PROCEDURE_PID}
* Retrieve all procedures available to the partner
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PartnerProceduresList {
procedures (Array[PartnerUserProcedureData], optional),
nb_started_segmented_procedures (integer, optional),
count (integer, optional),
index (integer, optional),
max_results (integer, optional)
}
PartnerUserProcedureData {
user (UserData, optional),
user_procedure_data (UserProcedureData, optional)
}
UserData {
login (string, optional),
title (string, optional),
first_name (string, optional),
last_name (string, optional),
birth_date (date-time, optional),
email (string, optional),
id_verified (boolean, optional),
address (ProfileAddressData, optional),
partner_user_id (string, optional)
}
ProfileAddressData {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
id (string, optional),
address_alias (string, optional)
address_aliasReg. Exp.:.{1,55}
,
valid (boolean, optional)
}
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedures": [
{
"user": {
"login": "string",
"title": "string",
"first_name": "string",
"last_name": "string",
"birth_date": "2024-09-23T11:00:41.698Z",
"email": "string",
"id_verified": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"id": "string",
"address_alias": "string",
"valid": true
},
"partner_user_id": "string"
},
"user_procedure_data": {
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.698Z",
"requested_date": "2024-09-23T11:00:41.698Z",
"created_at": "2024-09-23T11:00:41.698Z",
"updated_at": "2024-09-23T11:00:41.698Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
}
],
"nb_started_segmented_procedures": 0,
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type procedure_pid
procedure pid
path string status STARTED REQUESTED VALIDATED COMPLETED OBSOLETED
procedure status
query stringmax_results
maximum number of procedures to retrieve
query integer index
page index
query integer
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PARTNER/PROCEDURES
* Retrieve all user procedures of a specific procedure available to the
partner
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PartnerProceduresList {
procedures (Array[PartnerUserProcedureData], optional),
nb_started_segmented_procedures (integer, optional),
count (integer, optional),
index (integer, optional),
max_results (integer, optional)
}
PartnerUserProcedureData {
user (UserData, optional),
user_procedure_data (UserProcedureData, optional)
}
UserData {
login (string, optional),
title (string, optional),
first_name (string, optional),
last_name (string, optional),
birth_date (date-time, optional),
email (string, optional),
id_verified (boolean, optional),
address (ProfileAddressData, optional),
partner_user_id (string, optional)
}
ProfileAddressData {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
id (string, optional),
address_alias (string, optional)
address_aliasReg. Exp.:.{1,55}
,
valid (boolean, optional)
}
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedures": [
{
"user": {
"login": "string",
"title": "string",
"first_name": "string",
"last_name": "string",
"birth_date": "2024-09-23T11:00:41.701Z",
"email": "string",
"id_verified": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"id": "string",
"address_alias": "string",
"valid": true
},
"partner_user_id": "string"
},
"user_procedure_data": {
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.702Z",
"requested_date": "2024-09-23T11:00:41.702Z",
"created_at": "2024-09-23T11:00:41.702Z",
"updated_at": "2024-09-23T11:00:41.702Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
}
],
"nb_started_segmented_procedures": 0,
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type offset
specify which row should be fetched first.
query integer limit
limit the records returned.
query integer
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PARTNER/PROCEDURES/{PROCEDURE_PID}/STATS
* Retrieve statistics from procedures available to the partner
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PartnerProceduresList {
procedures (Array[PartnerUserProcedureData], optional),
nb_started_segmented_procedures (integer, optional),
count (integer, optional),
index (integer, optional),
max_results (integer, optional)
}
PartnerUserProcedureData {
user (UserData, optional),
user_procedure_data (UserProcedureData, optional)
}
UserData {
login (string, optional),
title (string, optional),
first_name (string, optional),
last_name (string, optional),
birth_date (date-time, optional),
email (string, optional),
id_verified (boolean, optional),
address (ProfileAddressData, optional),
partner_user_id (string, optional)
}
ProfileAddressData {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
id (string, optional),
address_alias (string, optional)
address_aliasReg. Exp.:.{1,55}
,
valid (boolean, optional)
}
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedures": [
{
"user": {
"login": "string",
"title": "string",
"first_name": "string",
"last_name": "string",
"birth_date": "2024-09-23T11:00:41.703Z",
"email": "string",
"id_verified": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"id": "string",
"address_alias": "string",
"valid": true
},
"partner_user_id": "string"
},
"user_procedure_data": {
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.703Z",
"requested_date": "2024-09-23T11:00:41.703Z",
"created_at": "2024-09-23T11:00:41.703Z",
"updated_at": "2024-09-23T11:00:41.703Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
}
],
"nb_started_segmented_procedures": 0,
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type procedure_pid
procedure pid
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid parameter, procedure
not found for the given PID 403 Access denied for the given procedure PID
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROCEDURE
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROCEDURE/{USER_PROCEDURE_ID}/REMINDERS
* Get list of reminders of a user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ReminderDataList {
reminders (Array[ReminderData], optional)
}
ReminderData {
id (string, optional),
title (string),
date (date-time),
document_id (string, optional),
procedure_id (string, optional)
}
{
"reminders": [
{
"id": "string",
"title": "string",
"date": "2024-09-23T11:00:41.704Z",
"document_id": "string",
"procedure_id": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Reminders not found 500
Internal error
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURE/{USER_PROCEDURE_ID}/REMINDER
* Create a reminder on a user procedure
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
Title and date of reminder that will be created
body
* Model
* Model Schema
ReminderInput {
title (string),
date (date-time)
}
{
"title": "string",
"date": "2024-09-23T11:00:41.470Z"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Title or date are invalids 404
user procedure not found 500 Internal error
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROCEDURE/{USER_PROCEDURE_ID}
* Updates a Specific user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.706Z",
"requested_date": "2024-09-23T11:00:41.706Z",
"created_at": "2024-09-23T11:00:41.706Z",
"updated_at": "2024-09-23T11:00:41.706Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
the updated procedure model
body
* Model
* Model Schema
SpecificProcedureInput {
modification_reason (string, optional),
name (string, optional),
assets (Array[RequiredDocumentNature], optional)
}
RequiredDocumentNature {
type (string) = ['CATEGORY' or 'NATURE' or 'OTHER']
typeEnum:"CATEGORY", "NATURE", "OTHER"
,
pid (string, optional)
pidReg. Exp.:^[A-Z0-9_]*$
,
title (string, optional),
count (integer)
countMin. Value:1Max. Value:100
}
{
"modification_reason": "string",
"name": "string",
"assets": [
{
"type": "string",
"pid": "string",
"title": "string",
"count": 0
}
]
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROCEDURE/{USER_PROCEDURE_ID}/MEMBERSHIP_ASSOCIATION/{MEMBERSHIP_ID}
* associate a membership with a procedure
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string membership_id
membership_id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Membership doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURE
* Assign a procedure to a user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.711Z",
"requested_date": "2024-09-23T11:00:41.711Z",
"created_at": "2024-09-23T11:00:41.711Z",
"updated_at": "2024-09-23T11:00:41.711Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
the procedure model
body
* Model
* Model Schema
SpecificProcedureInput {
modification_reason (string, optional),
name (string, optional),
assets (Array[RequiredDocumentNature], optional)
}
RequiredDocumentNature {
type (string) = ['CATEGORY' or 'NATURE' or 'OTHER']
typeEnum:"CATEGORY", "NATURE", "OTHER"
,
pid (string, optional)
pidReg. Exp.:^[A-Z0-9_]*$
,
title (string, optional),
count (integer)
countMin. Value:1Max. Value:100
}
{
"modification_reason": "string",
"name": "string",
"assets": [
{
"type": "string",
"pid": "string",
"title": "string",
"count": 0
}
]
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROCEDURE_USER
* Show/Hide
* List Operations
* Expand Operations
* * POST /PROCEDURE/USER/{USER_PROCEDURE_ID}/DOCUMENT
* Upload a document to user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.713Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.713Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.713Z"
},
"valid_until": "2024-09-23T11:00:41.713Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.713Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.713Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.713Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.713Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
Response Content Type application/json text/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string title
Parameter content type: multipart/form-data
The title of the document
body string hash
Parameter content type: multipart/form-data
The hash value of the document content
body string algo
Parameter content type: multipart/form-data
The hash algorithm to check the hash
body string archive_size
Parameter content type: multipart/form-data
Size of the archive
body long archive
The file to archive
body File
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The archive size is invalid
409 The document hash is wrong 413 The document to upload is too large
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROCEDURE/USER/{USER_PROCEDURE_ID}/DETAILS
* Retrieve an user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.716Z",
"requested_date": "2024-09-23T11:00:41.716Z",
"created_at": "2024-09-23T11:00:41.716Z",
"updated_at": "2024-09-23T11:00:41.716Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROCEDURE/USER/{USER_PROCEDURE_ID}/REPLACE-DOCUMENT
* Add new document to user procedure in a document category , use pid
instead of id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.717Z",
"requested_date": "2024-09-23T11:00:41.717Z",
"created_at": "2024-09-23T11:00:41.717Z",
"updated_at": "2024-09-23T11:00:41.717Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
Add document to user procedure
body
* Model
* Model Schema
ProcedureDocumentInput {
user_procedure_document_id (string, optional),
nature_id (string, optional),
nature_pid (string, optional),
document_ids (string, optional),
document_group (integer, optional),
add_to_latest_group (boolean, optional),
procedure_only (boolean, optional)
}
{
"user_procedure_document_id": "string",
"nature_id": "string",
"nature_pid": "string",
"document_ids": [
"string"
],
"document_group": 0,
"add_to_latest_group": true,
"procedure_only": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURE/USER/{USER_PROCEDURE_ID}/DELETE-DOCUMENT
* Delete the document from the procedure , use pid instead of id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.719Z",
"requested_date": "2024-09-23T11:00:41.719Z",
"created_at": "2024-09-23T11:00:41.719Z",
"updated_at": "2024-09-23T11:00:41.719Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
user procedure document id
body
* Model
* Model Schema
ProcedureDocumentInput {
user_procedure_document_id (string, optional),
nature_id (string, optional),
nature_pid (string, optional),
document_ids (string, optional),
document_group (integer, optional),
add_to_latest_group (boolean, optional),
procedure_only (boolean, optional)
}
{
"user_procedure_document_id": "string",
"nature_id": "string",
"nature_pid": "string",
"document_ids": [
"string"
],
"document_group": 0,
"add_to_latest_group": true,
"procedure_only": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROCEDURE/USER/{USER_PROCEDURE_ID}/SHARE
* Get the procedure share
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.721Z",
"end_date": "2024-09-23T11:00:41.721Z",
"last_view_at": "2024-09-23T11:00:41.721Z",
"created_at": "2024-09-23T11:00:41.721Z",
"updated_at": "2024-09-23T11:00:41.721Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURE/USER/{USER_PROCEDURE_ID}/SHARE
* Share the procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.726Z",
"end_date": "2024-09-23T11:00:41.726Z",
"last_view_at": "2024-09-23T11:00:41.726Z",
"created_at": "2024-09-23T11:00:41.726Z",
"updated_at": "2024-09-23T11:00:41.726Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
The share data
body
* Model
* Model Schema
ProcedureShareDataInput {
description (string, optional),
start_date (date-time),
end_date (date-time),
recipient_mails (string, optional),
security_code (string, optional),
share_date_range_under_one_year (boolean, optional)
}
{
"description": "string",
"start_date": "2024-09-23T11:00:41.470Z",
"end_date": "2024-09-23T11:00:41.470Z",
"recipient_mails": [
"string"
],
"security_code": "string",
"share_date_range_under_one_year": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROCEDURE/USER/{USER_PROCEDURE_ID}/SHARE
* Update the procedure share
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.727Z",
"end_date": "2024-09-23T11:00:41.727Z",
"last_view_at": "2024-09-23T11:00:41.727Z",
"created_at": "2024-09-23T11:00:41.727Z",
"updated_at": "2024-09-23T11:00:41.727Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
The share data
body
* Model
* Model Schema
ProcedureShareDataInput {
description (string, optional),
start_date (date-time),
end_date (date-time),
recipient_mails (string, optional),
security_code (string, optional),
share_date_range_under_one_year (boolean, optional)
}
{
"description": "string",
"start_date": "2024-09-23T11:00:41.470Z",
"end_date": "2024-09-23T11:00:41.470Z",
"recipient_mails": [
"string"
],
"security_code": "string",
"share_date_range_under_one_year": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROCEDURE/USER/{USER_PROCEDURE_ID}/SHARE
* Delete the procedure share
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURE/USER/{USER_PROCEDURE_ID}/ADD-DOCUMENT
* Add new document to user procedure in a document category , use pid
instead of id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.729Z",
"requested_date": "2024-09-23T11:00:41.729Z",
"created_at": "2024-09-23T11:00:41.729Z",
"updated_at": "2024-09-23T11:00:41.729Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
Add document to user procedure
body
* Model
* Model Schema
ProcedureDocumentInput {
user_procedure_document_id (string, optional),
nature_id (string, optional),
nature_pid (string, optional),
document_ids (string, optional),
document_group (integer, optional),
add_to_latest_group (boolean, optional),
procedure_only (boolean, optional)
}
{
"user_procedure_document_id": "string",
"nature_id": "string",
"nature_pid": "string",
"document_ids": [
"string"
],
"document_group": 0,
"add_to_latest_group": true,
"procedure_only": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROCEDURE/USER/{USER_PROCEDURE_ID}
* Retrieve an user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.730Z",
"requested_date": "2024-09-23T11:00:41.730Z",
"created_at": "2024-09-23T11:00:41.730Z",
"updated_at": "2024-09-23T11:00:41.730Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROCEDURE/USER/{USER_PROCEDURE_ID}
* Update a user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.731Z",
"requested_date": "2024-09-23T11:00:41.731Z",
"created_at": "2024-09-23T11:00:41.731Z",
"updated_at": "2024-09-23T11:00:41.731Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
new status of the user procedure
body
* Model
* Model Schema
ProcedureStatusInput {
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
}
{
"status": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid request parameters 403
Access to resource forbidden 404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROCEDURE/USER/{USER_PROCEDURE_ID}
* Delete the procedure for the user
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROCEDURE/USER/{USER_PROCEDURE_ID}/RESET
* Reset the procedure for the user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.733Z",
"requested_date": "2024-09-23T11:00:41.733Z",
"created_at": "2024-09-23T11:00:41.733Z",
"updated_at": "2024-09-23T11:00:41.733Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid request parameters 403
Access to resource forbidden 404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURE/USER/{USER_PROCEDURE_ID}/RENAME
* Rename a personal procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.734Z",
"requested_date": "2024-09-23T11:00:41.734Z",
"created_at": "2024-09-23T11:00:41.734Z",
"updated_at": "2024-09-23T11:00:41.734Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_procedure_id
user procedure id
path string body
Parameter content type: application/json
Rename user procedure
body
* Model
* Model Schema
ProcedureInput {
name (string, optional)
}
{
"name": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found 409 Can't rename user procedure
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROCEDURES
* Show/Hide
* List Operations
* Expand Operations
* * POST /PROCEDURES/{PROCEDURE_PID}/INIT
* Starts new user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.736Z",
"requested_date": "2024-09-23T11:00:41.736Z",
"created_at": "2024-09-23T11:00:41.736Z",
"updated_at": "2024-09-23T11:00:41.736Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type procedure_pid
procedure pid
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROCEDURES/INIT
* Starts new own user procedure
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.738Z",
"requested_date": "2024-09-23T11:00:41.738Z",
"created_at": "2024-09-23T11:00:41.738Z",
"updated_at": "2024-09-23T11:00:41.738Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add user procedure
body
* Model
* Model Schema
ProcedureInput {
name (string, optional)
}
{
"name": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROCEDURES
* Retrieve all procedures including user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProceduresList {
started (Array[UserProcedureData], optional),
available (Array[ProcedureData], optional)
}
UserProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional),
user_procedure_id (string, optional),
personal (boolean, optional),
completed (boolean, optional),
assets (Array[Asset], optional),
document_assets (Array[Asset], optional),
shared (boolean, optional),
visible (boolean, optional),
partner (PartnerData, optional),
status (string, optional) = ['STARTED' or 'REQUESTED' or 'VALIDATED' or
'COMPLETED' or 'OBSOLETED']
statusEnum:"STARTED", "REQUESTED", "VALIDATED", "COMPLETED", "OBSOLETED"
,
refusal_ground (string, optional),
qualification_date (date-time, optional),
requested_date (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
universes (UniverseItemSets, optional),
membership_id (string, optional),
first_name (string, optional),
last_name (string, optional),
prefix (string, optional)
}
PartnerData {
id (string, optional),
name (string, optional),
logo_url (string, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
ProcedureData {
procedure_id (string, optional),
procedure_pid (string, optional),
title (string, optional),
short_description (string, optional),
description (string, optional),
link (string, optional),
link_description (string, optional),
image (string, optional),
nb_assets_required (integer, optional),
nb_assets_provided (integer, optional),
pro_procedure (boolean, optional),
procedure_category (string, optional) = ['ADMINISTRATIVE' or 'BANK' or
'BUSINESS_CREATION' or 'HOUSING' or 'HEALTH' or 'WORK' or 'NONE']
procedure_categoryEnum:"ADMINISTRATIVE", "BANK", "BUSINESS_CREATION",
"HOUSING", "HEALTH", "WORK", "NONE"
,
associated_partners (Array[PartnerData], optional),
allow_partial_request (boolean, optional)
}
{
"started": [
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
{
"id": "string",
"name": "string",
"logo_url": "string"
}
],
"allow_partial_request": true,
"user_procedure_id": "string",
"personal": true,
"completed": true,
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"document_assets": {
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
},
"shared": true,
"visible": true,
"partner": {
"id": "string",
"name": "string",
"logo_url": "string"
},
"status": "string",
"refusal_ground": "string",
"qualification_date": "2024-09-23T11:00:41.739Z",
"requested_date": "2024-09-23T11:00:41.739Z",
"created_at": "2024-09-23T11:00:41.739Z",
"updated_at": "2024-09-23T11:00:41.739Z",
"type": "string",
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"membership_id": "string",
"first_name": "string",
"last_name": "string",
"prefix": "string"
}
],
"available": [
{
"procedure_id": "string",
"procedure_pid": "string",
"title": "string",
"short_description": "string",
"description": "string",
"link": "string",
"link_description": "string",
"image": "string",
"nb_assets_required": 0,
"nb_assets_provided": 0,
"pro_procedure": true,
"procedure_category": "string",
"associated_partners": [
"PartnerData"
],
"allow_partial_request": true
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROFILE
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROFILE
* Returns the profile data of the logged user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SimpleProfileData {
id (string, optional),
title (string, optional),
first_name (string, optional),
last_name (string, optional),
birth_name (string, optional),
date_of_birth (date, optional),
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
company_name (string, optional),
siren_siret (string, optional),
space_used (long, optional),
space_free (long, optional),
space_max (long, optional),
space_not_computed (long, optional),
author_name (string, optional),
support_available (boolean, optional),
secret_question_available (boolean, optional),
tos_version (string, optional),
tos_updated_at (date-time, optional),
share_space_status (string, optional) = ['NEED_COMPANY_DOCUMENTS' or
'LOCKED' or 'ACTIVE']
share_space_statusEnum:"NEED_COMPANY_DOCUMENTS", "LOCKED", "ACTIVE"
,
partial_account (boolean, optional),
basic_user (boolean, optional),
offer_pid (string, optional),
offer_updated_at (date-time, optional),
show2ddoc (boolean, optional),
idn_valid (boolean, optional),
last_connexion_date (date-time, optional),
completion (integer, optional),
locale (Locale, optional),
verified_documents (Array[VerifiedDocumentData], optional),
verify_profile (string, optional) = ['VERIFIED' or 'NO_VERIFIED' or
'PENDING']
verify_profileEnum:"VERIFIED", "NO_VERIFIED", "PENDING"
,
offer (ProfileOfferData, optional),
ccu_user (boolean, optional),
partner_name (string, optional),
new_offer (boolean, optional),
other_offer (string, optional),
first_connection (boolean, optional),
salaried (boolean, optional),
indexation_consent (boolean, optional),
ccu_user_id (string, optional),
international (boolean, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
VerifiedDocumentData {
document_id (string, optional),
extension (string, optional),
title (string, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
expiration_date (date-time, optional),
localized_nature_name (LocalizedString, optional),
nature_pid (string, optional)
}
LocalizedString {
id (string),
translations (Array[Translation], optional),
translations_indexed_by_string_locale (object, optional),
translations_indexed_by_locale (object, optional)
}
Translation {
locale (Locale, optional),
value (string, optional)
}
ProfileOfferData {
pid (string, optional),
type (string, optional),
product_id (string, optional),
max_safe_size (long, optional),
max_nb_collectors (integer, optional),
actual_safe_size (long, optional),
actual_nb_collectors (integer, optional),
subscription_date (date-time, optional),
sender_name (string, optional),
sender_pid (string, optional),
sender_logo_url (string, optional),
price (double, optional),
frequency (string, optional) = ['MONTHLY' or 'MONTH_6' or 'YEARLY']
frequencyEnum:"MONTHLY", "MONTH_6", "YEARLY"
}
{
"id": "string",
"title": "string",
"first_name": "string",
"last_name": "string",
"birth_name": "string",
"date_of_birth": "2024-09-23",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"status": "string",
"company_name": "string",
"siren_siret": "string",
"space_used": 0,
"space_free": 0,
"space_max": 0,
"space_not_computed": 0,
"author_name": "string",
"support_available": true,
"secret_question_available": true,
"tos_version": "string",
"tos_updated_at": "2024-09-23T11:00:41.741Z",
"share_space_status": "string",
"partial_account": true,
"basic_user": true,
"offer_pid": "string",
"offer_updated_at": "2024-09-23T11:00:41.741Z",
"show2ddoc": true,
"idn_valid": true,
"last_connexion_date": "2024-09-23T11:00:41.741Z",
"completion": 0,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"verified_documents": [
{
"document_id": "string",
"extension": "string",
"title": "string",
"verification_status": "string",
"expiration_date": "2024-09-23T11:00:41.741Z",
"localized_nature_name": {
"id": "string",
"translations": [
{
"locale": "Locale",
"value": "string"
}
],
"translations_indexed_by_string_locale": {},
"translations_indexed_by_locale": {}
},
"nature_pid": "string"
}
],
"verify_profile": "string",
"offer": {
"pid": "string",
"type": "string",
"product_id": "string",
"max_safe_size": 0,
"max_nb_collectors": 0,
"actual_safe_size": 0,
"actual_nb_collectors": 0,
"subscription_date": "2024-09-23T11:00:41.741Z",
"sender_name": "string",
"sender_pid": "string",
"sender_logo_url": "string",
"price": 0,
"frequency": "string"
},
"ccu_user": true,
"partner_name": "string",
"new_offer": true,
"other_offer": "string",
"first_connection": true,
"salaried": true,
"indexation_consent": true,
"ccu_user_id": "string",
"international": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type mode
The selected profile view mode, default is simple
query string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROFILE
* set the date of birth and/or the title of the logged user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SimpleProfileData {
id (string, optional),
title (string, optional),
first_name (string, optional),
last_name (string, optional),
birth_name (string, optional),
date_of_birth (date, optional),
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
company_name (string, optional),
siren_siret (string, optional),
space_used (long, optional),
space_free (long, optional),
space_max (long, optional),
space_not_computed (long, optional),
author_name (string, optional),
support_available (boolean, optional),
secret_question_available (boolean, optional),
tos_version (string, optional),
tos_updated_at (date-time, optional),
share_space_status (string, optional) = ['NEED_COMPANY_DOCUMENTS' or
'LOCKED' or 'ACTIVE']
share_space_statusEnum:"NEED_COMPANY_DOCUMENTS", "LOCKED", "ACTIVE"
,
partial_account (boolean, optional),
basic_user (boolean, optional),
offer_pid (string, optional),
offer_updated_at (date-time, optional),
show2ddoc (boolean, optional),
idn_valid (boolean, optional),
last_connexion_date (date-time, optional),
completion (integer, optional),
locale (Locale, optional),
verified_documents (Array[VerifiedDocumentData], optional),
verify_profile (string, optional) = ['VERIFIED' or 'NO_VERIFIED' or
'PENDING']
verify_profileEnum:"VERIFIED", "NO_VERIFIED", "PENDING"
,
offer (ProfileOfferData, optional),
ccu_user (boolean, optional),
partner_name (string, optional),
new_offer (boolean, optional),
other_offer (string, optional),
first_connection (boolean, optional),
salaried (boolean, optional),
indexation_consent (boolean, optional),
ccu_user_id (string, optional),
international (boolean, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
VerifiedDocumentData {
document_id (string, optional),
extension (string, optional),
title (string, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
expiration_date (date-time, optional),
localized_nature_name (LocalizedString, optional),
nature_pid (string, optional)
}
LocalizedString {
id (string),
translations (Array[Translation], optional),
translations_indexed_by_string_locale (object, optional),
translations_indexed_by_locale (object, optional)
}
Translation {
locale (Locale, optional),
value (string, optional)
}
ProfileOfferData {
pid (string, optional),
type (string, optional),
product_id (string, optional),
max_safe_size (long, optional),
max_nb_collectors (integer, optional),
actual_safe_size (long, optional),
actual_nb_collectors (integer, optional),
subscription_date (date-time, optional),
sender_name (string, optional),
sender_pid (string, optional),
sender_logo_url (string, optional),
price (double, optional),
frequency (string, optional) = ['MONTHLY' or 'MONTH_6' or 'YEARLY']
frequencyEnum:"MONTHLY", "MONTH_6", "YEARLY"
}
{
"id": "string",
"title": "string",
"first_name": "string",
"last_name": "string",
"birth_name": "string",
"date_of_birth": "2024-09-23",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"status": "string",
"company_name": "string",
"siren_siret": "string",
"space_used": 0,
"space_free": 0,
"space_max": 0,
"space_not_computed": 0,
"author_name": "string",
"support_available": true,
"secret_question_available": true,
"tos_version": "string",
"tos_updated_at": "2024-09-23T11:00:41.743Z",
"share_space_status": "string",
"partial_account": true,
"basic_user": true,
"offer_pid": "string",
"offer_updated_at": "2024-09-23T11:00:41.743Z",
"show2ddoc": true,
"idn_valid": true,
"last_connexion_date": "2024-09-23T11:00:41.743Z",
"completion": 0,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"verified_documents": [
{
"document_id": "string",
"extension": "string",
"title": "string",
"verification_status": "string",
"expiration_date": "2024-09-23T11:00:41.743Z",
"localized_nature_name": {
"id": "string",
"translations": [
{
"locale": "Locale",
"value": "string"
}
],
"translations_indexed_by_string_locale": {},
"translations_indexed_by_locale": {}
},
"nature_pid": "string"
}
],
"verify_profile": "string",
"offer": {
"pid": "string",
"type": "string",
"product_id": "string",
"max_safe_size": 0,
"max_nb_collectors": 0,
"actual_safe_size": 0,
"actual_nb_collectors": 0,
"subscription_date": "2024-09-23T11:00:41.743Z",
"sender_name": "string",
"sender_pid": "string",
"sender_logo_url": "string",
"price": 0,
"frequency": "string"
},
"ccu_user": true,
"partner_name": "string",
"new_offer": true,
"other_offer": "string",
"first_connection": true,
"salaried": true,
"indexation_consent": true,
"ccu_user_id": "string",
"international": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The user birthdate and title
body
* Model
* Model Schema
ProfileIdentityData {
title (string, optional),
birth_date (date, optional),
given_name (string, optional)
given_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
family_name (string, optional)
family_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
birth_name (string, optional)
birth_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
}
{
"title": "string",
"birth_date": "2024-09-23",
"given_name": "string",
"family_name": "string",
"birth_name": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/SAFE/SIZE
* Returns the safe size of the user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileSafeSize {
actual_safe_size (long, optional)
}
{
"actual_safe_size": 0
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/EMAILS
* Returns the internet emails of the logged user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileMails {
mails (Array[ProfileEmailData], optional)
}
ProfileEmailData {
id (string, optional),
email (string, optional),
type (string, optional),
valid (boolean, optional)
}
{
"mails": [
{
"id": "string",
"email": "string",
"type": "string",
"valid": true
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/EMAILTODIGIPOSTE
* Returns the emailtodigiposte of the logged user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileMailToDigiposte {
mailtodigiposte (string, optional),
validity_end_date (date-time, optional)
}
{
"mailtodigiposte": "string",
"validity_end_date": "2024-09-23T11:00:41.745Z"
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/EMAILTODIGIPOSTE/GENERATE
* Generates a new emailtodigiposte email address and revoke the old one
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileMailToDigiposte {
mailtodigiposte (string, optional),
validity_end_date (date-time, optional)
}
{
"mailtodigiposte": "string",
"validity_end_date": "2024-09-23T11:00:41.746Z"
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/ADDRESS/{ADDRESS_ID}
* Returns the address data for that id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileAddressData {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
id (string, optional),
address_alias (string, optional)
address_aliasReg. Exp.:.{1,55}
,
valid (boolean, optional)
}
{
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"id": "string",
"address_alias": "string",
"valid": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type address_id
The address ID to get
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 the address id doesn't exists
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/ADDRESSES
* Returns the profile data of the logged user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileAddresses {
addresses (Array[ProfileAddressData], optional)
}
ProfileAddressData {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional),
id (string, optional),
address_alias (string, optional)
address_aliasReg. Exp.:.{1,55}
,
valid (boolean, optional)
}
{
"addresses": [
{
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string",
"id": "string",
"address_alias": "string",
"valid": true
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/PHONES
* Gives phone number list , identified by the ID from the user profile
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
PhoneNumbersList {
phones (Array[PhoneNumberData], optional)
}
PhoneNumberData {
id (string, optional),
phone_number (string, optional),
type (string, optional),
label (string, optional)
}
{
"phones": [
{
"id": "string",
"phone_number": "string",
"type": "string",
"label": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
index of page , used for pagination
query integer max_results
max_results is used to limit number of item returned by API
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 index or maxResults are
invalid
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/PHONE
* Create new phone number
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Phone Number that will be created
body
* Model
* Model Schema
PhoneNumberInput {
phone_number (string),
type (string),
label (string)
}
{
"phone_number": "string",
"type": "string",
"label": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 500 Phone number ID is missing
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/PHONE/{PHONE_NUMBER_ID}
* Get phone number by ID
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type phone_number_id
ID of phone Number
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Phone number ID is missing
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROFILE/PHONE/{PHONE_NUMBER_ID}
* Modify phone number by ID
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
ID of phone Number that will be edited
body
* Model
* Model Schema
PhoneNumberInput {
phone_number (string),
type (string),
label (string)
}
{
"phone_number": "string",
"type": "string",
"label": "string"
}
Click to set as parameter value
phone_number_id path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Phone number already exist 404
Phone number ID is missing
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROFILE/PHONE/{PHONE_NUMBER_ID}
* Delete phone number by ID
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type phone_number_id
ID of phone Number that will be deleted
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Phone number ID is missing
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/APPLICATIONS
* Return the authorized applications
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
AuthorizedApplications {
authorized_applications (Array[AuthorizedApplication], optional)
}
AuthorizedApplication {
client_id (string, optional),
created_at (date-time, optional),
logo_url (string, optional),
application_name (string, optional),
localized_authorize_text (LocalizedString, optional)
}
LocalizedString {
id (string),
translations (Array[Translation], optional),
translations_indexed_by_string_locale (object, optional),
translations_indexed_by_locale (object, optional)
}
Translation {
locale (Locale, optional),
value (string, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
{
"authorized_applications": [
{
"client_id": "string",
"created_at": "2024-09-23T11:00:41.752Z",
"logo_url": "string",
"application_name": "string",
"localized_authorize_text": {
"id": "string",
"translations": [
{
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"value": "string"
}
],
"translations_indexed_by_string_locale": {},
"translations_indexed_by_locale": {}
}
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type notExpired true
false
return only not expired authorized applications
query boolean
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/SOFT-LOGOUT
* log out user from application, remove access
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 No access token found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/OFFER
* Update user's offer
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
UserOfferInput {
purchase_transaction (string, optional),
platform (string),
order_id (string, optional),
product_id (string, optional)
}
{
"purchase_transaction": "string",
"platform": "string",
"order_id": "string",
"product_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Offer doesn't exist 409
Purchase transaction already exists
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/OPTINS
* Get the user's optins
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROFILE/OPTINS
* Update the user's optins
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body undefined
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROFILE/LOCALE
* To update the user's locale
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
LocaleInput {
locale (string)
localeReg. Exp.:^[a-z]{2}_[A-Z]{2}|[a-z]{2}$
}
{
"locale": "string"
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/CCU
* Link an account digiposte to an account CCU
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SimpleProfileData {
id (string, optional),
title (string, optional),
first_name (string, optional),
last_name (string, optional),
birth_name (string, optional),
date_of_birth (date, optional),
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
company_name (string, optional),
siren_siret (string, optional),
space_used (long, optional),
space_free (long, optional),
space_max (long, optional),
space_not_computed (long, optional),
author_name (string, optional),
support_available (boolean, optional),
secret_question_available (boolean, optional),
tos_version (string, optional),
tos_updated_at (date-time, optional),
share_space_status (string, optional) = ['NEED_COMPANY_DOCUMENTS' or
'LOCKED' or 'ACTIVE']
share_space_statusEnum:"NEED_COMPANY_DOCUMENTS", "LOCKED", "ACTIVE"
,
partial_account (boolean, optional),
basic_user (boolean, optional),
offer_pid (string, optional),
offer_updated_at (date-time, optional),
show2ddoc (boolean, optional),
idn_valid (boolean, optional),
last_connexion_date (date-time, optional),
completion (integer, optional),
locale (Locale, optional),
verified_documents (Array[VerifiedDocumentData], optional),
verify_profile (string, optional) = ['VERIFIED' or 'NO_VERIFIED' or
'PENDING']
verify_profileEnum:"VERIFIED", "NO_VERIFIED", "PENDING"
,
offer (ProfileOfferData, optional),
ccu_user (boolean, optional),
partner_name (string, optional),
new_offer (boolean, optional),
other_offer (string, optional),
first_connection (boolean, optional),
salaried (boolean, optional),
indexation_consent (boolean, optional),
ccu_user_id (string, optional),
international (boolean, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
VerifiedDocumentData {
document_id (string, optional),
extension (string, optional),
title (string, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
expiration_date (date-time, optional),
localized_nature_name (LocalizedString, optional),
nature_pid (string, optional)
}
LocalizedString {
id (string),
translations (Array[Translation], optional),
translations_indexed_by_string_locale (object, optional),
translations_indexed_by_locale (object, optional)
}
Translation {
locale (Locale, optional),
value (string, optional)
}
ProfileOfferData {
pid (string, optional),
type (string, optional),
product_id (string, optional),
max_safe_size (long, optional),
max_nb_collectors (integer, optional),
actual_safe_size (long, optional),
actual_nb_collectors (integer, optional),
subscription_date (date-time, optional),
sender_name (string, optional),
sender_pid (string, optional),
sender_logo_url (string, optional),
price (double, optional),
frequency (string, optional) = ['MONTHLY' or 'MONTH_6' or 'YEARLY']
frequencyEnum:"MONTHLY", "MONTH_6", "YEARLY"
}
{
"id": "string",
"title": "string",
"first_name": "string",
"last_name": "string",
"birth_name": "string",
"date_of_birth": "2024-09-23",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"status": "string",
"company_name": "string",
"siren_siret": "string",
"space_used": 0,
"space_free": 0,
"space_max": 0,
"space_not_computed": 0,
"author_name": "string",
"support_available": true,
"secret_question_available": true,
"tos_version": "string",
"tos_updated_at": "2024-09-23T11:00:41.757Z",
"share_space_status": "string",
"partial_account": true,
"basic_user": true,
"offer_pid": "string",
"offer_updated_at": "2024-09-23T11:00:41.757Z",
"show2ddoc": true,
"idn_valid": true,
"last_connexion_date": "2024-09-23T11:00:41.757Z",
"completion": 0,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"verified_documents": [
{
"document_id": "string",
"extension": "string",
"title": "string",
"verification_status": "string",
"expiration_date": "2024-09-23T11:00:41.757Z",
"localized_nature_name": {
"id": "string",
"translations": [
{
"locale": "Locale",
"value": "string"
}
],
"translations_indexed_by_string_locale": {},
"translations_indexed_by_locale": {}
},
"nature_pid": "string"
}
],
"verify_profile": "string",
"offer": {
"pid": "string",
"type": "string",
"product_id": "string",
"max_safe_size": 0,
"max_nb_collectors": 0,
"actual_safe_size": 0,
"actual_nb_collectors": 0,
"subscription_date": "2024-09-23T11:00:41.757Z",
"sender_name": "string",
"sender_pid": "string",
"sender_logo_url": "string",
"price": 0,
"frequency": "string"
},
"ccu_user": true,
"partner_name": "string",
"new_offer": true,
"other_offer": "string",
"first_connection": true,
"salaried": true,
"indexation_consent": true,
"ccu_user_id": "string",
"international": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type token_dgp
Parameter content type: application/json
the token generated by digiposte.
body
* Model
* Model Schema
CcuTokenInput {
token_ccu (string, optional)
}
{
"token_ccu": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 201 Accounts linked. 400 Missing
mandatory argument 404 CCU user not found. 409 User part cannot be linked
to User pro.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /PROFILE/CONNECTIONS
* Returns the connections of the logged user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConnectionsData {
connections (Array[ConnectionData], optional)
}
ConnectionData {
user_agent_data (UserAgentData, optional),
connected_at (date-time, optional),
client_ip (string, optional)
}
UserAgentData {
device_class (string, optional),
device_name (string, optional),
device_version (string, optional),
operating_system_name (string, optional),
operating_system_version (string, optional),
agent_name (string, optional),
agent_version (string, optional)
}
{
"connections": [
{
"user_agent_data": {
"device_class": "string",
"device_name": "string",
"device_version": "string",
"operating_system_name": "string",
"operating_system_version": "string",
"agent_name": "string",
"agent_version": "string"
},
"connected_at": "2024-09-23T11:00:41.759Z",
"client_ip": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
Page index.
query integer max_results
Page size.
query integer
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid or missing pagination
parameters.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/LOGOUT
* log out user from application, remove access and refresh token
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 No access token found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROFILE_ACTIONS
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROFILE/ACTIONS/HELP_STATUS
* Returns the user's preferences about notification
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserActionHelpList {
actions (object, optional)
}
{
"actions": {}
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/ACTIONS/HELP_STATUS
* Sets action to executed
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserActionHelpList {
actions (object, optional)
}
{
"actions": {}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Executed action
body
* Model
* Model Schema
UserActionHelpList {
actions (object, optional)
}
{
"actions": {}
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROFILE_DOCUMENTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROFILE/DOCUMENTS
* Retrieve documents user profile
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileDocumentsData {
assets (Array[Asset], optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
{
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROFILE/DOCUMENTS
* Delete the documents from the profile
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
remove documents to user profile
body
* Model
* Model Schema
ProfileDocumentsNaturePidInput {
entries (Array[ProfileDocumentNaturePidEntry], optional)
}
ProfileDocumentNaturePidEntry {
profile_document_ids (string, optional),
nature_pid (string)
}
{
"entries": [
{
"profile_document_ids": [
"string"
],
"nature_pid": "string"
}
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /PROFILE/DOCUMENTS/ADD-DOCUMENT
* Add new document to user profile in a document category
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileDocumentsNaturePidData {
document_ids (string),
document_nature_pid (string, optional)
}
{
"document_ids": [
"string"
],
"document_nature_pid": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add document to user profile
body
* Model
* Model Schema
ProfileDocumentsNaturePidData {
document_ids (string),
document_nature_pid (string, optional)
}
{
"document_ids": [
"string"
],
"document_nature_pid": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROFILE/DOCUMENTS/REPLACE/{USER_PROFILE_DOCUMENT_ID}
* Add new document to user profile in a document category
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileDocumentsData {
assets (Array[Asset], optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
{
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type
user_profile_document_id
user profile document id
path string body
Parameter content type: application/json
Add document to user profile
body
* Model
* Model Schema
ProfileDocumentsInputData {
document_ids (string),
document_nature_id (string, optional)
}
{
"document_ids": [
"string"
],
"document_nature_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /PROFILE/DOCUMENTS/DELETE/{USER_PROFILE_DOCUMENT_ID}
* Delete the document from the profile
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileDocumentsData {
assets (Array[Asset], optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
{
"assets": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type
user_profile_document_id
user profile document id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 Access to resource forbidden
404 Domain object not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROFILE_NATURE
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROFILE/NATURE/{NATURE_PID}/DOCUMENTS
* Retrieve documents user profile for given nature
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ProfileDocumentList {
documents (Array[Asset], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
Asset {
id (string, optional),
pid (string, optional),
visible (boolean, optional),
title (string, optional),
description (string, optional),
asset_type (string, optional) = ['DOCUMENT' or 'DOCUMENT_GROUP' or
'NATURE' or 'CATEGORY']
asset_typeEnum:"DOCUMENT", "DOCUMENT_GROUP", "NATURE", "CATEGORY"
,
nb_documents (integer, optional),
nb_documents_required (integer, optional),
assets (Array[Asset], optional),
is_custom (boolean, optional)
}
{
"documents": [
{
"id": "string",
"pid": "string",
"visible": true,
"title": "string",
"description": "string",
"asset_type": "string",
"nb_documents": 0,
"nb_documents_required": 0,
"assets": [
"Asset"
],
"is_custom": true
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type nature_pid path
string index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* PROFILE_NOTIFICATION
* Show/Hide
* List Operations
* Expand Operations
* * GET /PROFILE/NOTIFICATIONS
* Returns the user's preferences about notification
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
NotificationPreferenceList {
preferences (Array[NotificationPreference], optional)
}
NotificationPreference {
type (string, optional),
enable (boolean, optional)
}
{
"preferences": [
{
"type": "string",
"enable": true
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /PROFILE/NOTIFICATIONS/{NOTIFICATION_TYPE}
* Modify user preference about notification
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type notification_type
path string body
Parameter content type: application/json
body
* Model
* Model Schema
NotificationPreferenceInput {
enable (boolean)
}
{
"enable": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* REMINDER
* Show/Hide
* List Operations
* Expand Operations
* * GET /REMINDER/{REMINDER_ID}
* Returns the reminder by id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type reminder_id
ID of reminder that will be returned
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 Reminder Not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /REMINDER/{REMINDER_ID}
* update reminder by id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type reminder_id
ID of reminder that will be updated
path string reminder_input
Parameter content type: application/json
ID of reminder that will be updated
body
* Model
* Model Schema
ReminderInput {
title (string),
date (date-time)
}
{
"title": "string",
"date": "2024-09-23T11:00:41.471Z"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 title is too long or date is
invalid 404 Reminder Not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /REMINDER/{REMINDER_ID}
* delete reminder by id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type reminder_id
ID of reminder that will be deleted
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 the reminder was deleted 404
Reminder Not found
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* REMINDERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /REMINDERS
* Returns next user reminders
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ReminderDataList {
reminders (Array[ReminderData], optional)
}
ReminderData {
id (string, optional),
title (string),
date (date-time),
document_id (string, optional),
procedure_id (string, optional)
}
{
"reminders": [
{
"id": "string",
"title": "string",
"date": "2024-09-23T11:00:41.771Z",
"document_id": "string",
"procedure_id": "string"
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type until
Until date (format :yyyyMMdd)
query string limit
Results limit (greater than 0)
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 One or more parameters are
invalid
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* ROUTAGE
* Show/Hide
* List Operations
* Expand Operations
* * GET /ROUTAGE/{ID_LOT}/REPORT
* Get the routage report
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type id_lot
lot id
path string type
type
query string integrity
integrity
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Format incorrect : Integrity
403 Le gestionnaire n'est pas autorisé à utiliser cet api pour cet
émetteur 404 Cannot found the sender with pid '{senderPid}' 500
Encountered an internal error.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SENDER
* Show/Hide
* List Operations
* Expand Operations
* * POST /SENDER/{PARTNERID}/CLONE
* clone a sender by its id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
{
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type partnerId
The sender pid to clone
path string legal_name
Parameter content type: multipart/form-data
Legal name
body string clone_partner_id
Parameter content type: multipart/form-data
clone_partner_id
body string siren_siret
Parameter content type: multipart/form-data
Siren/Siret
body string vat_number
Parameter content type: multipart/form-data
vat_number
body string street
Parameter content type: multipart/form-data
street
body string zip_code
Parameter content type: multipart/form-data
zipCode
body string locality
Parameter content type: multipart/form-data
locality
body string selfcare_url_fr
Parameter content type: multipart/form-data
selfcare_url_fr
body string label1_fr
Parameter content type: multipart/form-data
label1_fr
body string label2_fr
Parameter content type: multipart/form-data
label2_fr
body string field2_encoding
Parameter content type: multipart/form-data
field2_encoding
body string documents_naming_fr
Parameter content type: multipart/form-data
documents_naming_fr
body string security_redirect true false
security_redirect
body booleanspecial_offer
Parameter content type: multipart/form-data
special_offer
body string thumbnail
Parameter content type: multipart/form-data
thumbnail
body Attachment logo
Parameter content type: multipart/form-data
logo
body Attachment presentation_fr
Parameter content type: multipart/form-data
presentation_fr
body string more_info_fr
Parameter content type: multipart/form-data
more_info_fr
body string publisher_partner_id
Parameter content type: multipart/form-data
publisher_partner_id
body string tooltip1_fr
Parameter content type: multipart/form-data
tooltip1_fr
body string tooltip2_fr
Parameter content type: multipart/form-data
tooltip2_fr
body string field1_example
Parameter content type: multipart/form-data
field1_example
body string field2_example
Parameter content type: multipart/form-data
field2_example
body string label1_en
Parameter content type: multipart/form-data
Label 1 in english
body string tooltip1_en
Parameter content type: multipart/form-data
Tooltip 1 in english
body string label2_en
Parameter content type: multipart/form-data
Label 2 in english
body string tooltip2_en
Parameter content type: multipart/form-data
Tooltip 2 in english
body string presentation_en
Parameter content type: multipart/form-data
Presentation in english
body string more_info_en
Parameter content type: multipart/form-data
More info in english
body string selfcare_url_en
Parameter content type: multipart/form-data
English organisation url
body string document_naming_en
Parameter content type: multipart/form-data
Documents naming in english
body string alias
Parameter content type: multipart/form-data
List of aliases, comma seperated
body string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 no sender found with this id
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SENDERS
* Show/Hide
* List Operations
* Expand Operations
* * GET /SENDERS/{PID}
* Get sender by PID
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
SenderResponse {
pid (string, optional),
legal_name (string, optional),
siren_siret (string, optional),
vat_number (string, optional),
thumbnail (string, optional),
logo (string, optional),
selfcare_url_fr (string, optional),
selfcare_url_en (string, optional),
routing_emails (string, optional),
aliases (string, optional),
address (Address, optional),
membership_form_info (MembershipFormInfo, optional),
multilingual (boolean, optional),
deposit_regex (string, optional),
automatic_spool (boolean, optional)
}
Address {
street (string, optional),
zip_code (string, optional),
locality (string, optional),
country (string, optional)
}
MembershipFormInfo {
label1_fr (string, optional),
label1_en (string, optional),
tooltip1_fr (string, optional),
tooltip1_en (string, optional),
label2_fr (string, optional),
label2_en (string, optional),
tooltip2_fr (string, optional),
tooltip2_en (string, optional),
presentation_fr (string, optional),
presentation_en (string, optional),
more_info_fr (string, optional),
more_info_en (string, optional),
field1_example (string, optional),
field2_example (string, optional),
document_naming_fr (string, optional),
document_naming_en (string, optional)
}
{
"pid": "string",
"legal_name": "string",
"siren_siret": "string",
"vat_number": "string",
"thumbnail": "string",
"logo": "string",
"selfcare_url_fr": "string",
"selfcare_url_en": "string",
"routing_emails": [
"string"
],
"aliases": [
"string"
],
"address": {
"street": "string",
"zip_code": "string",
"locality": "string",
"country": "string"
},
"membership_form_info": {
"label1_fr": "string",
"label1_en": "string",
"tooltip1_fr": "string",
"tooltip1_en": "string",
"label2_fr": "string",
"label2_en": "string",
"tooltip2_fr": "string",
"tooltip2_en": "string",
"presentation_fr": "string",
"presentation_en": "string",
"more_info_fr": "string",
"more_info_en": "string",
"field1_example": "string",
"field2_example": "string",
"document_naming_fr": "string",
"document_naming_en": "string"
},
"multilingual": true,
"deposit_regex": "string",
"automatic_spool": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type pid
The sender pid
path string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SENDERS/{PID}
* Update sender
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type pid
The sender pid
path string label1_fr
Parameter content type: application/json
Label 1 in french
body string label1_en
Parameter content type: application/json
Label 1 in english
body string tooltip1_fr
Parameter content type: application/json
Tooltip 1 in french
body string tooltip1_en
Parameter content type: application/json
Tooltip 1 in english
body string label2_fr
Parameter content type: application/json
Label 2 in french
body string label2_en
Parameter content type: application/json
Label 2 in english
body string tooltip2_fr
Parameter content type: application/json
Tooltip 2 in french
body string tooltip2_en
Parameter content type: application/json
Tooltip 2 in english
body string presentation_fr
Parameter content type: application/json
Presentation in french
body string presentation_en
Parameter content type: application/json
Presentation in english
body string more_info_fr
Parameter content type: application/json
More info in french
body string more_info_en
Parameter content type: application/json
More info in english
body string field1_example
Parameter content type: application/json
Field1 example
body string field2_example
Parameter content type: application/json
Field2 example
body string selfcare_url_fr
Parameter content type: application/json
French organisation url
body string selfcare_url_en
Parameter content type: application/json
English organisation url
body string routing_emails
Parameter content type: application/json
Routing emails list comma separated
body string aliases
Parameter content type: application/json
Alias list comma separated
body string street
Parameter content type: application/json
Street part of the address
body string country
Parameter content type: application/json
Country part of the address
body string locality
Parameter content type: application/json
Locality part of the address
body string zip_code
Parameter content type: application/json
Zipcode part of the address
body string siren_siret
Parameter content type: application/json
Siren/Siret
body string vat_number
Parameter content type: application/json
Vat number
body string legal_name
Parameter content type: application/json
Legal name
body string thumbnail
Parameter content type: application/json
Thumbnail image
body Attachment logo
Parameter content type: application/json
Logo image
body Attachment
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SENDERS/CREATE
* Create sender
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CreatedSenderResponse {
id (string, optional),
pid (string, optional)
}
{
"id": "string",
"pid": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type pid
Parameter content type: application/json
Pid
body string legal_name
Parameter content type: application/json
Legal name
body string siren_siret
Parameter content type: application/json
Siren/Siret
body string vat_number
Parameter content type: application/json
Vat number
body string type
Parameter content type: application/json
Type
body string visible true false
Visibile
body booleanfindable true false
Findable
body booleansecurity_redirect true false
Security redirect
body booleanmulti_subscription true false
Multi subscription
body booleanmultilingual true false
Multilingual
body booleanhr true false
HR
body booleanhealth true false
Health
body booleanfirst_notification_type
Parameter content type: application/json
First notification type
body string number_of_personalization_email_reminders
Parameter content type: application/json
Number of personalization email reminders
body integer self_cancellation true false
Self cancellation
body booleanself_cancellation_timeout
Parameter content type: application/json
Self cancellation timeout
body integer alias_allowed true false
Alias allowed
body booleannotification_type
Parameter content type: application/json
Notification type
body string label1_fr
Parameter content type: application/json
Label 1 in french
body string label1_en
Parameter content type: application/json
Label 1 in english
body string tooltip1_fr
Parameter content type: application/json
Tooltip 1 in french
body string tooltip1_en
Parameter content type: application/json
Tooltip 1 in english
body string label2_fr
Parameter content type: application/json
Label 2 in french
body string label2_en
Parameter content type: application/json
Label 2 in english
body string tooltip2_fr
Parameter content type: application/json
Tooltip 2 in french
body string tooltip2_en
Parameter content type: application/json
Tooltip 2 in english
body string presentation_fr
Parameter content type: application/json
Presentation in french
body string presentation_en
Parameter content type: application/json
Presentation in english
body string more_info_fr
Parameter content type: application/json
More info in french
body string more_info_en
Parameter content type: application/json
More info in english
body string documents_naming_fr
Parameter content type: application/json
Documents naming in french
body string documents_naming_en
Parameter content type: application/json
Documents naming in english
body string field1_example
Parameter content type: application/json
Field1 example
body string field2_example
Parameter content type: application/json
Field2 example
body string selfcare_url_fr
Parameter content type: application/json
French organisation url
body string selfcare_url_en
Parameter content type: application/json
English organisation url
body string routing_emails
Parameter content type: application/json
Routing emails list comma separated
body string aliases
Parameter content type: application/json
Alias list comma separated
body string street
Parameter content type: application/json
Street part of the address
body string country
Parameter content type: application/json
Country part of the address
body string locality
Parameter content type: application/json
Locality part of the address
body string zip_code
Parameter content type: application/json
Zipcode part of the address
body string thumbnail
Parameter content type: application/json
Thumbnail image
body Attachment logo
Parameter content type: application/json
Logo image
body Attachment dematerialized_sender_side true false
Dematerialized agreement sender side
body booleandematerialized_agreement_url
Parameter content type: application/json
Dematerialized agreement url
body string category
Parameter content type: application/json
Category
body string publisher_partner_id
Parameter content type: application/json
Parent publisher pid
body string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SHARE
* Show/Hide
* List Operations
* Expand Operations
* * GET /SHARE/{SHARE_ID}
* Returns the user's share with the given id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.798Z",
"end_date": "2024-09-23T11:00:41.798Z",
"last_view_at": "2024-09-23T11:00:41.798Z",
"created_at": "2024-09-23T11:00:41.798Z",
"updated_at": "2024-09-23T11:00:41.798Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Identifiant du partage à retourner
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 The share does not belong to
the authenticated user 404 The share does not exist 409 The share space
of the currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /SHARE/{SHARE_ID}
* Update an existing share
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.799Z",
"end_date": "2024-09-23T11:00:41.799Z",
"last_view_at": "2024-09-23T11:00:41.799Z",
"created_at": "2024-09-23T11:00:41.799Z",
"updated_at": "2024-09-23T11:00:41.799Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Identifiant du partage à updater
path string body
Parameter content type: application/json
The share data
body
* Model
* Model Schema
DocumentShareDataInput {
description (string, optional),
start_date (date-time),
end_date (date-time),
recipient_mails (string, optional),
security_code (string, optional),
title (string, optional),
share_date_range_under_one_year (boolean, optional)
}
{
"description": "string",
"start_date": "2024-09-23T11:00:41.471Z",
"end_date": "2024-09-23T11:00:41.471Z",
"recipient_mails": [
"string"
],
"security_code": "string",
"title": "string",
"share_date_range_under_one_year": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The share data provided tries
to update the resource id 403 The share to update does not belong to the
authenticated user 404 The share to update does not exist 409 The share
space of the currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /SHARE/{SHARE_ID}
* Returns the user's share with the given id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Identifiant du partage à retourner
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 The share does not belong to
the authenticated user 404 The share does not exist 409 The share space
of the currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SHARE/{SHARE_ID}/DOCUMENTS
* Returns the user's share with the given id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareDocumentList {
documents (Array[ShareDocument], optional)
}
ShareDocument {
id (string, optional),
title (string, optional),
filename (string, optional),
certified (boolean, optional),
content_type (string, optional),
sender_name (string, optional),
sender_logo (string, optional),
author_name (string, optional),
creation_date (date-time, optional),
share_date (date-time, optional),
size (integer, optional),
category (string, optional),
read (boolean, optional),
folder_id (string, optional),
digishoot (boolean, optional),
geolocalized (boolean, optional),
geolocalized_data (GeolocalizedData, optional),
health_document (boolean, optional),
reference_doc (boolean, optional),
favorite (boolean, optional),
shared (boolean, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
{
"documents": [
{
"id": "string",
"title": "string",
"filename": "string",
"certified": true,
"content_type": "string",
"sender_name": "string",
"sender_logo": "string",
"author_name": "string",
"creation_date": "2024-09-23T11:00:41.801Z",
"share_date": "2024-09-23T11:00:41.801Z",
"size": 0,
"category": "string",
"read": true,
"folder_id": "string",
"digishoot": true,
"geolocalized": true,
"geolocalized_data": {
"timestamping": "2024-09-23T11:00:41.801Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.801Z"
},
"health_document": true,
"reference_doc": true,
"favorite": true,
"shared": true,
"verification_status": "string",
"verify_profile": true
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Identifiant du partage à retourner
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 The share does not belong to
the authenticated user 404 The share does not exist 409 The share space
of the currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /SHARE/{SHARE_ID}/DOCUMENTS
* Update the documents of a share
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type share_id
Identifiant du partage
path string body
Parameter content type: application/json
Les ids des documents à mettre dans le partage
body
* Model
* Model Schema
IdSet {
ids (string)
}
{
"ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 403 One of the documents does not
belong to the authenticated user 404 One of the documents does not exist
409 The share space of the currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SHARE
* Create a new share for the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.803Z",
"end_date": "2024-09-23T11:00:41.803Z",
"last_view_at": "2024-09-23T11:00:41.803Z",
"created_at": "2024-09-23T11:00:41.803Z",
"updated_at": "2024-09-23T11:00:41.803Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The share data
body
* Model
* Model Schema
DocumentShareDataInput {
description (string, optional),
start_date (date-time),
end_date (date-time),
recipient_mails (string, optional),
security_code (string, optional),
title (string, optional),
share_date_range_under_one_year (boolean, optional)
}
{
"description": "string",
"start_date": "2024-09-23T11:00:41.471Z",
"end_date": "2024-09-23T11:00:41.471Z",
"recipient_mails": [
"string"
],
"security_code": "string",
"title": "string",
"share_date_range_under_one_year": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The share data can't provide
an id 409 The share space of the currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SHARES
* Show/Hide
* List Operations
* Expand Operations
* * GET /SHARES
* Returns the user's shares
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareDataList {
share_datas (Array[ShareData], optional)
}
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
{
"share_datas": [
{
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.804Z",
"end_date": "2024-09-23T11:00:41.804Z",
"last_view_at": "2024-09-23T11:00:41.804Z",
"created_at": "2024-09-23T11:00:41.804Z",
"updated_at": "2024-09-23T11:00:41.804Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type type
DOCUMENT or PROCEDURE, missing or unknown value return ALL
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 The share space of the
currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SHARES/WITH_DOCUMENTS
* Returns the user's shares
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareDataAndDocumentsList {
share_data_and_documents (Array[ShareDataAndDocuments], optional)
}
ShareDataAndDocuments {
share_data (ShareData, optional),
documents (Array[ShareDocument], optional)
}
ShareData {
id (string, optional),
short_id (string, optional),
security_code (string, optional),
short_url (string, optional),
title (string, optional),
description (string, optional),
start_date (date-time, optional),
end_date (date-time, optional),
last_view_at (date-time, optional),
created_at (date-time, optional),
updated_at (date-time, optional),
user_procedure_id (string, optional),
recipient_mails (string, optional)
}
ShareDocument {
id (string, optional),
title (string, optional),
filename (string, optional),
certified (boolean, optional),
content_type (string, optional),
sender_name (string, optional),
sender_logo (string, optional),
author_name (string, optional),
creation_date (date-time, optional),
share_date (date-time, optional),
size (integer, optional),
category (string, optional),
read (boolean, optional),
folder_id (string, optional),
digishoot (boolean, optional),
geolocalized (boolean, optional),
geolocalized_data (GeolocalizedData, optional),
health_document (boolean, optional),
reference_doc (boolean, optional),
favorite (boolean, optional),
shared (boolean, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
{
"share_data_and_documents": [
{
"share_data": {
"id": "string",
"short_id": "string",
"security_code": "string",
"short_url": "string",
"title": "string",
"description": "string",
"start_date": "2024-09-23T11:00:41.804Z",
"end_date": "2024-09-23T11:00:41.804Z",
"last_view_at": "2024-09-23T11:00:41.804Z",
"created_at": "2024-09-23T11:00:41.804Z",
"updated_at": "2024-09-23T11:00:41.804Z",
"user_procedure_id": "string",
"recipient_mails": [
"string"
]
},
"documents": [
{
"id": "string",
"title": "string",
"filename": "string",
"certified": true,
"content_type": "string",
"sender_name": "string",
"sender_logo": "string",
"author_name": "string",
"creation_date": "2024-09-23T11:00:41.804Z",
"share_date": "2024-09-23T11:00:41.804Z",
"size": 0,
"category": "string",
"read": true,
"folder_id": "string",
"digishoot": true,
"geolocalized": true,
"geolocalized_data": {
"timestamping": "2024-09-23T11:00:41.804Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.804Z"
},
"health_document": true,
"reference_doc": true,
"favorite": true,
"shared": true,
"verification_status": "string",
"verify_profile": true
}
]
}
]
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type type
DOCUMENT or PROCEDURE, missing or unknown value return ALL
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 The share space of the
currently connected user is not active
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SHARES/CONTACTS/WITH_DOCUMENTS
* Returns the user's contact document shares
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ShareDocumentList {
documents (Array[ShareDocument], optional)
}
ShareDocument {
id (string, optional),
title (string, optional),
filename (string, optional),
certified (boolean, optional),
content_type (string, optional),
sender_name (string, optional),
sender_logo (string, optional),
author_name (string, optional),
creation_date (date-time, optional),
share_date (date-time, optional),
size (integer, optional),
category (string, optional),
read (boolean, optional),
folder_id (string, optional),
digishoot (boolean, optional),
geolocalized (boolean, optional),
geolocalized_data (GeolocalizedData, optional),
health_document (boolean, optional),
reference_doc (boolean, optional),
favorite (boolean, optional),
shared (boolean, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
{
"documents": [
{
"id": "string",
"title": "string",
"filename": "string",
"certified": true,
"content_type": "string",
"sender_name": "string",
"sender_logo": "string",
"author_name": "string",
"creation_date": "2024-09-23T11:00:41.805Z",
"share_date": "2024-09-23T11:00:41.805Z",
"size": 0,
"category": "string",
"read": true,
"folder_id": "string",
"digishoot": true,
"geolocalized": true,
"geolocalized_data": {
"timestamping": "2024-09-23T11:00:41.805Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.805Z"
},
"health_document": true,
"reference_doc": true,
"favorite": true,
"shared": true,
"verification_status": "string",
"verify_profile": true
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SIGN
* Show/Hide
* List Operations
* Expand Operations
* * GET /SIGN
* Returns all signature for the given user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
DocumentList {
documents (Array[FullDocumentMetaData], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
FullDocumentMetaData {
id (string, optional),
category (string, optional),
filename (string, optional),
title (string, optional),
subtitle (string, optional),
summary (string, optional),
mimetype (string, optional),
size (integer, optional),
creation_date (date-time, optional),
sender_name (string, optional),
author_name (string, optional),
health_document (boolean, optional),
sender_logo (string, optional),
document_logo (string, optional),
location (string, optional) = ['INBOX' or 'SAFE' or 'TRASH_INBOX' or
'TRASH_SAFE']
locationEnum:"INBOX", "SAFE", "TRASH_INBOX", "TRASH_SAFE"
,
read (boolean, optional),
shared (boolean, optional),
digishoot (boolean, optional),
certified (boolean, optional),
self_care_url (string, optional),
invoice (boolean, optional),
invoice_data (InvoiceData, optional),
valid_until (date-time, optional),
eligible2ddoc (boolean, optional),
folder_id (string, optional),
favorite (boolean, optional),
user_tags (string, optional),
sender_tags (string, optional),
owner (boolean, optional),
digishoot_data (GeolocalizedData, optional),
geolocalized (boolean, optional),
geolocalize_data (GeolocalizedData, optional),
verification_status (string, optional) = ['REJECTED' or 'UNREADABLE' or
'EXPIRED' or 'VALIDATED' or 'PENDING' or 'UNREACHABLE' or 'CALL']
verification_statusEnum:"REJECTED", "UNREADABLE", "EXPIRED", "VALIDATED",
"PENDING", "UNREACHABLE", "CALL"
,
verify_profile (boolean, optional),
universes (UniverseItemSets, optional),
reference_doc (boolean, optional),
nature_pid (string, optional),
nature_id (string, optional),
nature_name (object, optional),
category_id (string, optional),
category_name (object, optional),
category_icon (string, optional),
category_pid (string, optional),
extension (string, optional)
}
InvoiceData {
payment_indicator (string, optional) = ['PRE_AUTHORIZED_PAYMENT' or
'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicatorEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
payment_indicator_update (string, optional) = ['PRE_AUTHORIZED_PAYMENT'
or 'TO_PAY' or 'PAYED' or 'CANCELLED' or 'PAYED_WITH_DIGIPOSTE']
payment_indicator_updateEnum:"PRE_AUTHORIZED_PAYMENT", "TO_PAY", "PAYED",
"CANCELLED", "PAYED_WITH_DIGIPOSTE"
,
chargeable_amount (float, optional),
due_on (date-time, optional),
currency (string, optional),
payable (boolean, optional),
transaction_id (string, optional),
transaction_epel_date (date-time, optional)
}
GeolocalizedData {
timestamping (date-time, optional),
latitude (double, optional),
longitude (double, optional),
position_type (string, optional),
hdop (string, optional),
timestamp (date-time, optional)
}
UniverseItemSets {
goods (Array[ItemData], optional),
contacts (Array[ItemData], optional),
jobs (Array[ItemData], optional),
housings (Array[ItemData], optional),
health (Array[ItemData], optional)
}
ItemData {
id (string, optional),
name (string, optional)
}
{
"documents": [
{
"id": "string",
"category": "string",
"filename": "string",
"title": "string",
"subtitle": "string",
"summary": "string",
"mimetype": "string",
"size": 0,
"creation_date": "2024-09-23T11:00:41.806Z",
"sender_name": "string",
"author_name": "string",
"health_document": true,
"sender_logo": "string",
"document_logo": "string",
"location": "string",
"read": true,
"shared": true,
"digishoot": true,
"certified": true,
"self_care_url": "string",
"invoice": true,
"invoice_data": {
"payment_indicator": "string",
"payment_indicator_update": "string",
"chargeable_amount": 0,
"due_on": "2024-09-23T11:00:41.806Z",
"currency": "string",
"payable": true,
"transaction_id": "string",
"transaction_epel_date": "2024-09-23T11:00:41.806Z"
},
"valid_until": "2024-09-23T11:00:41.806Z",
"eligible2ddoc": true,
"folder_id": "string",
"favorite": true,
"user_tags": [
"string"
],
"sender_tags": [
"string"
],
"owner": true,
"digishoot_data": {
"timestamping": "2024-09-23T11:00:41.806Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.806Z"
},
"geolocalized": true,
"geolocalize_data": {
"timestamping": "2024-09-23T11:00:41.806Z",
"latitude": 0,
"longitude": 0,
"position_type": "string",
"hdop": "string",
"timestamp": "2024-09-23T11:00:41.806Z"
},
"verification_status": "string",
"verify_profile": true,
"universes": {
"goods": [
{
"id": "string",
"name": "string"
}
],
"contacts": {
"id": "string",
"name": "string"
},
"jobs": {
"id": "string",
"name": "string"
},
"housings": {
"id": "string",
"name": "string"
},
"health": {
"id": "string",
"name": "string"
}
},
"reference_doc": true,
"nature_pid": [
"string"
],
"nature_id": "string",
"nature_name": {},
"category_id": "string",
"category_name": {},
"category_icon": "string",
"category_pid": "string",
"extension": "string"
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /SIGN/{SIGNATUREID}/ACT
* User can sign or refuse
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type signatureId path
string userAction query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SIGN/{SIGNATUREID}/URL
* Returns sign url for a given signature
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
StringValue {
value (string, optional)
}
{
"value": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type signatureId path
string doneUrl query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Bad pagination values provided
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* SUPPORTING
* Show/Hide
* List Operations
* Expand Operations
* * GET /SUPPORTING/TYPE
* Returns the categories list for an user
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SUPPORTING/NATURE/{NATURE_ID}
* Returns documents for a nature
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type nature_id
nature id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The nature doesn't exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /SUPPORTING/REFERENTIAL
* Returns every category and nature
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /SUPPORTING/DOCUMENT/NATURE
* Update nature for a specified document
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
request body containing nature and documents ids
body
* Model
* Model Schema
DocumentNatureInput {
nature_id (string, optional),
document_ids (string, optional)
}
{
"nature_id": "string",
"document_ids": [
"string"
]
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Documents natures successfully
updated 400 The document or nature doesn't exist 430 Part of document
list not updated
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /SUPPORTING/DOCUMENT/NATURE
* Removes every natures from a document
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
request body with documents ids
body undefined
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Documents' nature(s) deleted
400 Document not found or does not belong to current user
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * HEAD /SUPPORTING/REFRESH
* Refresh caches linked to categories
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 The caches were refreshed
successfully
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TIMELINE
* Show/Hide
* List Operations
* Expand Operations
* * GET /TIMELINE
* Get the time line of the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TimeLineResponse {
events (Array[TimeLineEvent], optional),
count (long, optional),
index (integer, optional),
max_results (integer, optional)
}
TimeLineEvent {
id (string, optional),
type (string, optional),
category (string, optional),
action_date (date-time, optional),
date (date-time, optional),
status (string, optional) = ['ARCHIVED' or 'NOT_ARCHIVED']
statusEnum:"ARCHIVED", "NOT_ARCHIVED"
,
document (DocumentDetails, optional),
membership (MembershipDetails, optional),
procedure (ProcedureDetails, optional),
sender (SenderDetails, optional),
share (ShareDetails, optional),
folder (FolderDetails, optional),
trusted_contact (TrustedContactDetails, optional),
profil_details (ProfileDetails, optional),
reminder_details (ReminderDetails, optional),
delete_documents_count (long, optional),
document_nature_pid (string, optional),
user_procedure_id (string, optional),
folder_count (integer, optional),
quota_used (integer, optional),
coreg_partner_user_id (string, optional),
contact (ContactDetails, optional),
good (GoodDetails, optional),
housing (HousingDetails, optional),
message (string, optional),
sender_email (string, optional),
nb_uploaded_doc (integer, optional)
}
DocumentDetails {
id (string, optional),
name (string, optional),
verification_status (string, optional),
folder_id (string, optional),
folder_name (string, optional),
document_natures (string, optional),
document_counts (long, optional),
logo_url (string, optional),
verified_profile (boolean, optional)
}
MembershipDetails {
id (string, optional),
field_one (string, optional),
status (string, optional),
status_details (string, optional)
}
ProcedureDetails {
id (string, optional),
name (string, optional),
documents_count (long, optional),
add_documents_count (long, optional),
type (string, optional),
partner_name (string, optional),
reason (string, optional),
document_errors (Array[DocumentErrorDetails], optional)
}
DocumentErrorDetails {
name (string, optional),
reason (string, optional)
}
SenderDetails {
pid (string, optional),
name (string, optional),
logo_url (string, optional)
}
ShareDetails {
id (string, optional),
title (string, optional),
start_date (date-time, optional),
expiration_date (date-time, optional)
}
FolderDetails {
id (string, optional),
name (string, optional)
}
TrustedContactDetails {
id (string, optional),
family_name (string, optional),
given_name (string, optional)
}
ProfileDetails {
completion (integer, optional),
fields (string, optional),
offer_pid (string, optional)
}
ReminderDetails {
message (string, optional)
}
ContactDetails {
id (string, optional),
first_name (string, optional),
last_name (string, optional),
relationship_type (string, optional) = ['GRANDPARENT' or 'PARENT' or
'PARTNER' or 'CHILD' or 'GRANDCHILD' or 'OTHER' or 'CONTACT']
relationship_typeEnum:"GRANDPARENT", "PARENT", "PARTNER", "CHILD",
"GRANDCHILD", "OTHER", "CONTACT"
,
status (string, optional) = ['UNINVITED' or 'WAITING_VALIDATION' or
'VALID']
statusEnum:"UNINVITED", "WAITING_VALIDATION", "VALID"
}
GoodDetails {
id (string, optional),
name (string, optional),
type (string, optional)
}
HousingDetails {
id (string, optional),
name (string, optional),
type (string, optional)
}
{
"events": [
{
"id": "string",
"type": "string",
"category": "string",
"action_date": "2024-09-23T11:00:41.811Z",
"date": "2024-09-23T11:00:41.811Z",
"status": "string",
"document": {
"id": "string",
"name": "string",
"verification_status": "string",
"folder_id": "string",
"folder_name": "string",
"document_natures": [
"string"
],
"document_counts": 0,
"logo_url": "string",
"verified_profile": true
},
"membership": {
"id": "string",
"field_one": "string",
"status": "string",
"status_details": "string"
},
"procedure": {
"id": "string",
"name": "string",
"documents_count": 0,
"add_documents_count": 0,
"type": "string",
"partner_name": "string",
"reason": "string",
"document_errors": [
{
"name": "string",
"reason": "string"
}
]
},
"sender": {
"pid": "string",
"name": "string",
"logo_url": "string"
},
"share": {
"id": "string",
"title": "string",
"start_date": "2024-09-23T11:00:41.811Z",
"expiration_date": "2024-09-23T11:00:41.811Z"
},
"folder": {
"id": "string",
"name": "string"
},
"trusted_contact": {
"id": "string",
"family_name": "string",
"given_name": "string"
},
"profil_details": {
"completion": 0,
"fields": [
"string"
],
"offer_pid": "string"
},
"reminder_details": {
"message": "string"
},
"delete_documents_count": 0,
"document_nature_pid": "string",
"user_procedure_id": "string",
"folder_count": 0,
"quota_used": 0,
"coreg_partner_user_id": "string",
"contact": {
"id": "string",
"first_name": "string",
"last_name": "string",
"relationship_type": "string",
"status": "string"
},
"good": {
"id": "string",
"name": "string",
"type": "string"
},
"housing": {
"id": "string",
"name": "string",
"type": "string"
},
"message": "string",
"sender_email": "string",
"nb_uploaded_doc": 0
}
],
"count": 0,
"index": 0,
"max_results": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type index
The index of the pagination
query integer max_results
The maximum number of results returned
query integer since_id
The returned items should be created after the item whose id is the given
field
query string max_id
The returned items should be created before the item whose id is the
given field
query string type
The type of the returned items
query string status ARCHIVED NOT_ARCHIVED
Status of timeline events
query string
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /TIMELINE/ALL
* Change the status of all events on the timeline
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type status
Parameter content type: application/json
Status of timeline events
body
* Model
* Model Schema
TimelineStatusInput {
hidden (boolean, optional),
archived (boolean, optional)
}
{
"hidden": true,
"archived": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /TIMELINE/{ITEM_ID}
* Change timeline events status from user's newsfeed
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type item_id path string
status
Parameter content type: application/json
Status of timeline events
body
* Model
* Model Schema
TimelineStatusInput {
hidden (boolean, optional),
archived (boolean, optional)
}
{
"hidden": true,
"archived": true
}
Click to set as parameter value
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TOKEN_INFO
* Show/Hide
* List Operations
* Expand Operations
* * GET /TOKEN_INFO
* Retrieve token informations
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TokenInfo {
type (string, optional) = ['USER' or 'PARTNER']
typeEnum:"USER", "PARTNER"
,
user (UserInfo, optional),
partner (PartnerInfo, optional),
sender (SenderInfo, optional)
}
UserInfo {
user_id (string, optional)
}
PartnerInfo {
client_id (string, optional),
partner_id (string, optional)
}
SenderInfo {
sender_id (string, optional),
sender_pid (string, optional)
}
{
"type": "string",
"user": {
"user_id": "string"
},
"partner": {
"client_id": "string",
"partner_id": "string"
},
"sender": {
"sender_id": "string",
"sender_pid": "string"
}
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TRUSTED_CONTACT
* Show/Hide
* List Operations
* Expand Operations
* * GET /TRUSTED_CONTACT/{TRUSTED_CONTACT_ID}
* Get trusted contact by id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TrustedContactData {
id (string, optional),
title (string, optional),
given_name (string, optional),
family_name (string, optional),
email (string, optional),
date_of_birth (date, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
legator (LegatorData, optional)
}
LegatorData {
given_name (string, optional),
family_name (string, optional)
}
{
"id": "string",
"title": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"date_of_birth": "2024-09-23",
"status": "string",
"legator": {
"given_name": "string",
"family_name": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type trusted_contact_id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The requested trusted contact
does not exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /TRUSTED_CONTACT/{TRUSTED_CONTACT_ID}
* Delete trusted contact by id
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type trusted_contact_id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The requested trusted contact
does not exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /TRUSTED_CONTACT/{TRUSTED_CONTACT_ID}/EMAIL
* Send invitation email to the trusted contact
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type trusted_contact_id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The requested trusted contact
does not exist 409 The trusted contact's status is not WAITING
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /TRUSTED_CONTACT/{TRUSTED_CONTACT_ID}/ATTACH_USER
* Attach current user to a trusted contact
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type trusted_contact_id
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 The requested trusted contact
does not exist 409 The trusted contact's status is not WAITING
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /TRUSTED_CONTACT/{TRUSTED_CONTACT_ID}/STATUS
* Update the status of a trusted contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TrustedContactData {
id (string, optional),
title (string, optional),
given_name (string, optional),
family_name (string, optional),
email (string, optional),
date_of_birth (date, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
legator (LegatorData, optional)
}
LegatorData {
given_name (string, optional),
family_name (string, optional)
}
{
"id": "string",
"title": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"date_of_birth": "2024-09-23",
"status": "string",
"legator": {
"given_name": "string",
"family_name": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type trusted_contact_id
path string body
Parameter content type: application/json
body
* Model
* Model Schema
TrustedContactStatusInput {
status (string) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
}
{
"status": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 The status 'WAITING' is not
accepted 404 The requested trusted contact does not exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /TRUSTED_CONTACT
* Create a trusted contact
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TrustedContactData {
id (string, optional),
title (string, optional),
given_name (string, optional),
family_name (string, optional),
email (string, optional),
date_of_birth (date, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
legator (LegatorData, optional)
}
LegatorData {
given_name (string, optional),
family_name (string, optional)
}
{
"id": "string",
"title": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"date_of_birth": "2024-09-23",
"status": "string",
"legator": {
"given_name": "string",
"family_name": "string"
}
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Trusted Contact Info
body
* Model
* Model Schema
TrustedContactInput {
title (string, optional),
given_name (string, optional)
given_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
family_name (string, optional)
family_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
email (string, optional),
date_of_birth (date, optional)
}
{
"title": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"date_of_birth": "2024-09-23"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Input data are incorrect 409
The user can't add himself as a trusted contact
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* TRUSTED_CONTACTS
* Show/Hide
* List Operations
* Expand Operations
* * GET /TRUSTED_CONTACTS
* Get trusted contacts of the current user
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
TrustedContactsData {
trusted_contacts (Array[TrustedContactData], optional)
}
TrustedContactData {
id (string, optional),
title (string, optional),
given_name (string, optional),
family_name (string, optional),
email (string, optional),
date_of_birth (date, optional),
status (string, optional) = ['REFUSED' or 'WAITING' or 'ACCEPTED']
statusEnum:"REFUSED", "WAITING", "ACCEPTED"
,
legator (LegatorData, optional)
}
LegatorData {
given_name (string, optional),
family_name (string, optional)
}
{
"trusted_contacts": [
{
"id": "string",
"title": "string",
"given_name": "string",
"family_name": "string",
"email": "string",
"date_of_birth": "2024-09-23",
"status": "string",
"legator": {
"given_name": "string",
"family_name": "string"
}
}
]
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER
* Show/Hide
* List Operations
* Expand Operations
* * POST /USER
* Creates a full user account using encrypted password via pinpad
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserRegistrationReport {
user (UserOutput, optional),
registration (RegistrationStatus, optional),
nb_document_by_user_id (integer, optional)
}
UserOutput {
partner_user_id (string, optional),
created_at (date-time, optional),
title (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
email (string, optional),
partial_account (boolean, optional),
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
partner (PartnerInfos, optional),
account_type (string, optional) = ['IHM' or 'REGISTRATION' or
'COREGISTRATION' or 'VALIDATE_MEMBERSHIP']
account_typeEnum:"IHM", "REGISTRATION", "COREGISTRATION",
"VALIDATE_MEMBERSHIP"
,
procedures (Array[LightUserProcedureData], optional),
idnlinked (boolean, optional)
}
PartnerInfos {
application_name (string, optional),
document_name (string, optional),
logo_url (string, optional),
partner_id (string, optional),
sender (SenderMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
LightUserProcedureData {
id (string, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
name (string, optional)
}
RegistrationStatus {
id (string, optional),
email_quality (string, optional) = ['CHECKED' or 'INFORMATION']
email_qualityEnum:"CHECKED", "INFORMATION"
,
address_quality (string, optional) = ['CHECKED' or 'INFORMATION']
address_qualityEnum:"CHECKED", "INFORMATION"
,
process (string, optional) = ['ADH' or 'AFF' or 'ASD' or 'ASS']
processEnum:"ADH", "AFF", "ASD", "ASS"
,
sender_meta_data (SenderMetaData, optional),
membership (MembershipMetaData, optional),
membershipstatus (string, optional) = ['CREATION_ERROR' or 'CANCELLED' or
'VALIDATED_BY_USER' or 'PRE_VALIDATED_BY_SENDER' or 'WAITING_SENDER' or
'ACTIVE' or 'CANCEL_IN_PROGRESS' or 'REFUSED' or
'ADDRESS_CHECKING_IN_PROGRESS' or 'REFUSAL_SOLICITATION' or 'IN_ERROR']
membershipstatusEnum:"CREATION_ERROR", "CANCELLED", "VALIDATED_BY_USER",
"PRE_VALIDATED_BY_SENDER", "WAITING_SENDER", "ACTIVE",
"CANCEL_IN_PROGRESS", "REFUSED", "ADDRESS_CHECKING_IN_PROGRESS",
"REFUSAL_SOLICITATION", "IN_ERROR"
,
association_status (string, optional) = ['DELETED' or 'EMITED' or
'IN_PROGRESS' or 'VALID' or 'CANCEL_IN_PROGRESS']
association_statusEnum:"DELETED", "EMITED", "IN_PROGRESS", "VALID",
"CANCEL_IN_PROGRESS"
}
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"user": {
"partner_user_id": "string",
"created_at": "2024-09-23T11:00:41.820Z",
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"partial_account": true,
"status": "string",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"partner": {
"application_name": "string",
"document_name": "string",
"logo_url": "string",
"partner_id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
}
},
"account_type": "string",
"procedures": [
{
"id": "string",
"type": "string",
"name": "string"
}
],
"idnlinked": true
},
"registration": {
"id": "string",
"email_quality": "string",
"address_quality": "string",
"process": "string",
"sender_meta_data": "SenderMetaData",
"membership": {
"id": "string",
"sender": "SenderMetaData",
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.820Z",
"membership_date": "2024-09-23T11:00:41.820Z",
"request_date": "2024-09-23T11:00:41.820Z",
"cancellation_date": "2024-09-23T11:00:41.820Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.820Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.820Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.820Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.820Z"
}
},
"membershipstatus": "string",
"association_status": "string"
},
"nb_document_by_user_id": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The user account to create
body
* Model
* Model Schema
PinpadFullUserAccountInput {
title (string, optional),
user_type (string),
last_name (string)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
email (string, optional),
login (string, optional)
loginReg. Exp.:^[A-Za-z0-9_\-@\.\+]*$
,
siren_siret (string, optional),
company_name (string, optional),
secret_question (string, optional),
secret_question_index (integer, optional),
secret_answer (string, optional),
optin (boolean, optional),
idn_information (IDNInformation, optional),
partner_optin (boolean, optional),
address (AddressInput, optional),
accept_full_dematerialization (boolean, optional),
locale (Locale, optional),
password (PinpadInput),
raw_password (string, optional),
valid_secret_question_data (boolean, optional),
valid (boolean, optional)
}
IDNInformation {
prefix (string, optional),
last_name (string, optional),
first_name (string, optional),
birth_date (date, optional),
address (string, optional),
postal_code (string, optional),
city (string, optional),
country (string, optional),
email (string, optional),
idn_information_signature (string, optional),
email_signature (string, optional),
id (string, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
PinpadInput {
input (string, optional)
inputReg. Exp.:[0-9]{6}
,
sequence (string, optional),
password (string)
}
{
"title": "string",
"user_type": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"login": "string",
"siren_siret": "string",
"company_name": "string",
"secret_question": "string",
"secret_question_index": 0,
"secret_answer": "string",
"optin": true,
"idn_information": {
"prefix": "string",
"last_name": "string",
"first_name": "string",
"birth_date": "2024-09-23",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"email": "string",
"idn_information_signature": "string",
"email_signature": "string",
"id": "string"
},
"partner_optin": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"accept_full_dematerialization": true,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"password": {
"input": "string",
"sequence": "string",
"password": "string"
},
"raw_password": "string",
"valid_secret_question_data": true,
"valid": true
}
Click to set as parameter value
registrationId
pré-registration identifier
query string fieldValue1
Sender Security+ form field1 value
query string fieldValue2
Sender Security+ form field2 value
query string tokenCustomization
customization token (coregistration)
query string trustedContactId
trusted contact identifier
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 cannot creates user with this
parameters 409 login already exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER/NOTIF/{USER_ID}
* retrieve user account information for notif by id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserForNotif {
first_name (string, optional),
last_name (string, optional),
email (string, optional),
title (string, optional),
locale (string, optional)
}
{
"first_name": "string",
"last_name": "string",
"email": "string",
"title": "string",
"locale": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type user_id
The user id to retrieve
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 invalid id 404 no user with
this id
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER/WITH_RAW_PASSWORD
* Creates a full user account using raw password
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserRegistrationReport {
user (UserOutput, optional),
registration (RegistrationStatus, optional),
nb_document_by_user_id (integer, optional)
}
UserOutput {
partner_user_id (string, optional),
created_at (date-time, optional),
title (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
email (string, optional),
partial_account (boolean, optional),
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
partner (PartnerInfos, optional),
account_type (string, optional) = ['IHM' or 'REGISTRATION' or
'COREGISTRATION' or 'VALIDATE_MEMBERSHIP']
account_typeEnum:"IHM", "REGISTRATION", "COREGISTRATION",
"VALIDATE_MEMBERSHIP"
,
procedures (Array[LightUserProcedureData], optional),
idnlinked (boolean, optional)
}
PartnerInfos {
application_name (string, optional),
document_name (string, optional),
logo_url (string, optional),
partner_id (string, optional),
sender (SenderMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
LightUserProcedureData {
id (string, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
name (string, optional)
}
RegistrationStatus {
id (string, optional),
email_quality (string, optional) = ['CHECKED' or 'INFORMATION']
email_qualityEnum:"CHECKED", "INFORMATION"
,
address_quality (string, optional) = ['CHECKED' or 'INFORMATION']
address_qualityEnum:"CHECKED", "INFORMATION"
,
process (string, optional) = ['ADH' or 'AFF' or 'ASD' or 'ASS']
processEnum:"ADH", "AFF", "ASD", "ASS"
,
sender_meta_data (SenderMetaData, optional),
membership (MembershipMetaData, optional),
membershipstatus (string, optional) = ['CREATION_ERROR' or 'CANCELLED' or
'VALIDATED_BY_USER' or 'PRE_VALIDATED_BY_SENDER' or 'WAITING_SENDER' or
'ACTIVE' or 'CANCEL_IN_PROGRESS' or 'REFUSED' or
'ADDRESS_CHECKING_IN_PROGRESS' or 'REFUSAL_SOLICITATION' or 'IN_ERROR']
membershipstatusEnum:"CREATION_ERROR", "CANCELLED", "VALIDATED_BY_USER",
"PRE_VALIDATED_BY_SENDER", "WAITING_SENDER", "ACTIVE",
"CANCEL_IN_PROGRESS", "REFUSED", "ADDRESS_CHECKING_IN_PROGRESS",
"REFUSAL_SOLICITATION", "IN_ERROR"
,
association_status (string, optional) = ['DELETED' or 'EMITED' or
'IN_PROGRESS' or 'VALID' or 'CANCEL_IN_PROGRESS']
association_statusEnum:"DELETED", "EMITED", "IN_PROGRESS", "VALID",
"CANCEL_IN_PROGRESS"
}
MembershipMetaData {
id (string, optional),
sender (SenderMetaData, optional),
label (string, optional),
status (string, optional),
status_detail (string, optional),
error_message (string, optional),
original_error_message (string, optional),
frequency (string, optional) = ['NONE' or 'DAILY' or 'WEEKLY' or
'BIWEEKLY' or 'MONTHLY' or 'BIMONTHLY' or 'TRIMONTHLY' or 'SIXMONTHLY' or
'YEARLY']
frequencyEnum:"NONE", "DAILY", "WEEKLY", "BIWEEKLY", "MONTHLY",
"BIMONTHLY", "TRIMONTHLY", "SIXMONTHLY", "YEARLY"
,
next_collect_at (date-time, optional),
membership_date (date-time, optional),
request_date (date-time, optional),
cancellation_date (date-time, optional),
dematerialized_convention_version (string, optional),
dematerialized_convention_date (date-time, optional),
field1_value (string, optional),
field2_value (string, optional),
field1_label (string, optional),
field2_label (string, optional),
address (AddressInput, optional),
updated_at (date-time, optional),
sender_kind (integer, optional),
cancellable (boolean, optional),
inbox_folder_id (string, optional),
deactivation_date (date-time, optional),
enable (boolean, optional),
transaction_id (string, optional),
two_fa_provider (boolean, optional),
alias (string, optional),
note (string, optional),
consent_meta_data (ConsentMetaData, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
ConsentMetaData {
id (string, optional),
expiration_date (date-time, optional)
}
{
"user": {
"partner_user_id": "string",
"created_at": "2024-09-23T11:00:41.824Z",
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"partial_account": true,
"status": "string",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"partner": {
"application_name": "string",
"document_name": "string",
"logo_url": "string",
"partner_id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
}
},
"account_type": "string",
"procedures": [
{
"id": "string",
"type": "string",
"name": "string"
}
],
"idnlinked": true
},
"registration": {
"id": "string",
"email_quality": "string",
"address_quality": "string",
"process": "string",
"sender_meta_data": "SenderMetaData",
"membership": {
"id": "string",
"sender": "SenderMetaData",
"label": "string",
"status": "string",
"status_detail": "string",
"error_message": "string",
"original_error_message": "string",
"frequency": "string",
"next_collect_at": "2024-09-23T11:00:41.824Z",
"membership_date": "2024-09-23T11:00:41.824Z",
"request_date": "2024-09-23T11:00:41.824Z",
"cancellation_date": "2024-09-23T11:00:41.824Z",
"dematerialized_convention_version": "string",
"dematerialized_convention_date": "2024-09-23T11:00:41.824Z",
"field1_value": "string",
"field2_value": "string",
"field1_label": "string",
"field2_label": "string",
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"updated_at": "2024-09-23T11:00:41.824Z",
"sender_kind": 0,
"cancellable": true,
"inbox_folder_id": "string",
"deactivation_date": "2024-09-23T11:00:41.824Z",
"enable": true,
"transaction_id": "string",
"two_fa_provider": true,
"alias": "string",
"note": "string",
"consent_meta_data": {
"id": "string",
"expiration_date": "2024-09-23T11:00:41.824Z"
}
},
"membershipstatus": "string",
"association_status": "string"
},
"nb_document_by_user_id": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The user account to create
body
* Model
* Model Schema
RawPasswordFullUserAccountInput {
title (string, optional),
user_type (string),
last_name (string)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
email (string, optional),
login (string, optional)
loginReg. Exp.:^[A-Za-z0-9_\-@\.\+]*$
,
siren_siret (string, optional),
company_name (string, optional),
secret_question (string, optional),
secret_question_index (integer, optional),
secret_answer (string, optional),
optin (boolean, optional),
idn_information (IDNInformation, optional),
partner_optin (boolean, optional),
address (AddressInput, optional),
accept_full_dematerialization (boolean, optional),
locale (Locale, optional),
password (string),
raw_password (string, optional),
valid_secret_question_data (boolean, optional),
valid (boolean, optional)
}
IDNInformation {
prefix (string, optional),
last_name (string, optional),
first_name (string, optional),
birth_date (date, optional),
address (string, optional),
postal_code (string, optional),
city (string, optional),
country (string, optional),
email (string, optional),
idn_information_signature (string, optional),
email_signature (string, optional),
id (string, optional)
}
AddressInput {
sub_locality (string, optional),
street_address (string, optional),
postal_code (string, optional),
post_office_box (string, optional),
locality (string, optional),
extended_address (string, optional),
country_code (string, optional)
}
Locale {
language (string, optional),
script (string, optional),
country (string, optional),
variant (string, optional),
extension_keys (string, optional),
unicode_locale_attributes (string, optional),
unicode_locale_keys (string, optional),
iso3_language (string, optional),
iso3_country (string, optional),
display_language (string, optional),
display_script (string, optional),
display_country (string, optional),
display_variant (string, optional),
display_name (string, optional)
}
{
"title": "string",
"user_type": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"login": "string",
"siren_siret": "string",
"company_name": "string",
"secret_question": "string",
"secret_question_index": 0,
"secret_answer": "string",
"optin": true,
"idn_information": {
"prefix": "string",
"last_name": "string",
"first_name": "string",
"birth_date": "2024-09-23",
"address": "string",
"postal_code": "string",
"city": "string",
"country": "string",
"email": "string",
"idn_information_signature": "string",
"email_signature": "string",
"id": "string"
},
"partner_optin": true,
"address": {
"sub_locality": "string",
"street_address": "string",
"postal_code": "string",
"post_office_box": "string",
"locality": "string",
"extended_address": "string",
"country_code": "string"
},
"accept_full_dematerialization": true,
"locale": {
"language": "string",
"script": "string",
"country": "string",
"variant": "string",
"extension_keys": [
"string"
],
"unicode_locale_attributes": [
"string"
],
"unicode_locale_keys": [
"string"
],
"iso3_language": "string",
"iso3_country": "string",
"display_language": "string",
"display_script": "string",
"display_country": "string",
"display_variant": "string",
"display_name": "string"
},
"password": "string",
"raw_password": "string",
"valid_secret_question_data": true,
"valid": true
}
Click to set as parameter value
registrationId
pré-registration identifier
query string fieldValue1
Sender Security+ form field1 value
query string fieldValue2
Sender Security+ form field2 value
query string tokenCustomization
customization token (coregistration)
query string trustedContactId
trusted contact identifier
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 cannot creates user with this
parameters 409 login already exist
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER/PARTIAL
* Creates a partial user account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserOutput {
partner_user_id (string, optional),
created_at (date-time, optional),
title (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
email (string, optional),
partial_account (boolean, optional),
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
partner (PartnerInfos, optional),
account_type (string, optional) = ['IHM' or 'REGISTRATION' or
'COREGISTRATION' or 'VALIDATE_MEMBERSHIP']
account_typeEnum:"IHM", "REGISTRATION", "COREGISTRATION",
"VALIDATE_MEMBERSHIP"
,
procedures (Array[LightUserProcedureData], optional),
idnlinked (boolean, optional)
}
PartnerInfos {
application_name (string, optional),
document_name (string, optional),
logo_url (string, optional),
partner_id (string, optional),
sender (SenderMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
LightUserProcedureData {
id (string, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
name (string, optional)
}
{
"partner_user_id": "string",
"created_at": "2024-09-23T11:00:41.826Z",
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"partial_account": true,
"status": "string",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"partner": {
"application_name": "string",
"document_name": "string",
"logo_url": "string",
"partner_id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
}
},
"account_type": "string",
"procedures": [
{
"id": "string",
"type": "string",
"name": "string"
}
],
"idnlinked": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The partial user account payload
body
* Model
* Model Schema
PartialAccountInput {
title (string, optional),
last_name (string, optional)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string, optional)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
birth_name (string, optional)
birth_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
email (string, optional),
partner_user_id (string, optional),
with_membership_creation (boolean, optional)
}
{
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"birth_name": "string",
"email": "string",
"partner_user_id": "string",
"with_membership_creation": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 409 client id already exist for
current partner
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /USER/PARTIAL
* close an user account (and delete all user documents)
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 le user_id est manquant 403 le
compte a déjà été transformé 404 utilisateur non trouvé
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER/PARTIAL/FULL
* Create a new user, generate a web link and place premium offer.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserAndCustomUrlOutput {
partner_user_id (string, optional),
created_at (date-time, optional),
customization_url (string, optional)
}
{
"partner_user_id": "string",
"created_at": "2024-09-23T11:00:41.828Z",
"customization_url": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
PartialAccountFullInput {
title (string, optional),
last_name (string, optional)
last_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
first_name (string, optional)
first_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
date_of_birth (date, optional),
birth_name (string, optional)
birth_nameReg.
Exp.:^[a-zA-ZàáâãäåæœçèéêëìíîïðñòóôõöøùúûüýÿÀÁÂÃÄÅÆŒÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝŸ'\-\s]*$
,
email (string, optional),
partner_user_id (string, optional),
purchase_transaction (string, optional),
platform (string),
product_id (string, optional),
partner_plan (string, optional)
}
{
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"birth_name": "string",
"email": "string",
"partner_user_id": "string",
"purchase_transaction": "string",
"platform": "string",
"product_id": "string",
"partner_plan": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Wrong or missing mandatory
parameters, or unknown platform 404 Product_id not found 409
partner_user_id or purchase_transaction already exist for current partner
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER/PARTIAL/MERGE
* Merge the partial account into the full user account
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The coregistration info of partial account
body
* Model
* Model Schema
CoregPartnerUserInput {
coreg_partner_user_id (string, optional),
partner_id (string, optional)
}
{
"coreg_partner_user_id": "string",
"partner_id": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 partial account is not
authorized to be merged with a company account 409 partial account and
full account both have a membership to the same sender who does not allow
multiple memberships for the same user
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER/PARTIAL/CHECK_MERGE
* Determines if the merge of the partial account into the full user
account is possible
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
The coregistration infos concerning merge
body
* Model
* Model Schema
CheckPartialAccountMergeInput {
coreg_partner_user_id (string, optional),
partner_id (string, optional),
login (string, optional),
ccu (boolean, optional),
kind (string) = ['PERSON' or 'COMPANY']
kindEnum:"PERSON", "COMPANY"
}
{
"coreg_partner_user_id": "string",
"partner_id": "string",
"login": "string",
"ccu": true,
"kind": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 partial account is not
authorized to be merged with a company account 409 partial account and
full account both have a membership to the same sender who does not allow
multiple memberships for the same user
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER/LOGINS/AVAILABLE_CCU
* retrieve user's account that can be couple for given email and pid
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserPearingInfoList {
logins (Array[UserPearingInfo], optional),
count (integer, optional)
}
UserPearingInfo {
login (string, optional),
available (boolean, optional)
}
{
"logins": [
{
"login": "string",
"available": true
}
],
"count": 0
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type email
Email for which we will search user's accounts
query string pid
Sender's public id for validations on membership
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 invalid parameters
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER/CCU_USER/{CCU_USER_ID}
* retrieve user account information by ccu_user_id
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserOutput {
partner_user_id (string, optional),
created_at (date-time, optional),
title (string, optional),
last_name (string, optional),
first_name (string, optional),
date_of_birth (date, optional),
email (string, optional),
partial_account (boolean, optional),
status (string, optional) = ['CREATED' or 'TEMPORALLY_VALID' or 'VALID'
or 'CANCELED' or 'REMOVED']
statusEnum:"CREATED", "TEMPORALLY_VALID", "VALID", "CANCELED", "REMOVED"
,
id_xiti (long, optional),
login (string, optional),
user_type (string, optional) = ['PERSON' or 'COMPANY']
user_typeEnum:"PERSON", "COMPANY"
,
partner (PartnerInfos, optional),
account_type (string, optional) = ['IHM' or 'REGISTRATION' or
'COREGISTRATION' or 'VALIDATE_MEMBERSHIP']
account_typeEnum:"IHM", "REGISTRATION", "COREGISTRATION",
"VALIDATE_MEMBERSHIP"
,
procedures (Array[LightUserProcedureData], optional),
idnlinked (boolean, optional)
}
PartnerInfos {
application_name (string, optional),
document_name (string, optional),
logo_url (string, optional),
partner_id (string, optional),
sender (SenderMetaData, optional)
}
SenderMetaData {
id (string, optional),
pid (string, optional),
form_data (FormData, optional),
name (string, optional),
logo (string, optional),
alternative_logo (string, optional),
type (string, optional),
sender_side_convention (boolean, optional),
subscription_url (string, optional),
convention_url (string, optional),
convention_version (string, optional),
document_naming (string, optional),
auto_resiliation (boolean, optional),
category (string, optional),
category_id (string, optional),
document_nature_id (string, optional),
collected (boolean, optional),
contracted (boolean, optional),
contracted_creation_enabled (boolean, optional),
url_selfcare (string, optional),
url_sign_up (string, optional),
url_lost_password (string, optional),
push_block (string, optional),
vip (boolean, optional),
hr (boolean, optional),
optional_address (boolean, optional),
multilingual (boolean, optional),
convention_required (boolean, optional),
mail_trust (boolean, optional),
dynamic_subscription (boolean, optional),
api_collected (boolean, optional),
manual_collect (boolean, optional),
pro_collector (boolean, optional),
maintenance (boolean, optional),
share_cancel_consent_url (string, optional),
multi_subscription (boolean, optional),
biller (boolean, optional)
}
FormData {
sender_pid (string, optional),
presentation (string, optional),
field1_label (string, optional),
field2_label (string, optional),
field1_tooltip (string, optional),
field2_tooltip (string, optional),
example_field1 (string, optional),
example_field2 (string, optional),
more_info (string, optional),
creation_info (string, optional),
security_plus (boolean, optional)
}
LightUserProcedureData {
id (string, optional),
type (string, optional) = ['GENERIC' or 'PERSONAL' or 'SPECIFIC' or
'PRIVATE' or 'SEGMENTED']
typeEnum:"GENERIC", "PERSONAL", "SPECIFIC", "PRIVATE", "SEGMENTED"
,
name (string, optional)
}
{
"partner_user_id": "string",
"created_at": "2024-09-23T11:00:41.831Z",
"title": "string",
"last_name": "string",
"first_name": "string",
"date_of_birth": "2024-09-23",
"email": "string",
"partial_account": true,
"status": "string",
"id_xiti": 0,
"login": "string",
"user_type": "string",
"partner": {
"application_name": "string",
"document_name": "string",
"logo_url": "string",
"partner_id": "string",
"sender": {
"id": "string",
"pid": "string",
"form_data": {
"sender_pid": "string",
"presentation": "string",
"field1_label": "string",
"field2_label": "string",
"field1_tooltip": "string",
"field2_tooltip": "string",
"example_field1": "string",
"example_field2": "string",
"more_info": "string",
"creation_info": "string",
"security_plus": true
},
"name": "string",
"logo": "string",
"alternative_logo": "string",
"type": "string",
"sender_side_convention": true,
"subscription_url": "string",
"convention_url": "string",
"convention_version": "string",
"document_naming": "string",
"auto_resiliation": true,
"category": "string",
"category_id": "string",
"document_nature_id": "string",
"collected": true,
"contracted": true,
"contracted_creation_enabled": true,
"url_selfcare": "string",
"url_sign_up": "string",
"url_lost_password": "string",
"push_block": "string",
"vip": true,
"hr": true,
"optional_address": true,
"multilingual": true,
"convention_required": true,
"mail_trust": true,
"dynamic_subscription": true,
"api_collected": true,
"manual_collect": true,
"pro_collector": true,
"maintenance": true,
"share_cancel_consent_url": "string",
"multi_subscription": true,
"biller": true
}
},
"account_type": "string",
"procedures": [
{
"id": "string",
"type": "string",
"name": "string"
}
],
"idnlinked": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type ccu_user_id
The CCU_USER_ID of the user to retrieve
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 invalid ccu_user_id 404 no
user with this ccu_user_id
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER/CCU_ACCOUNT_CHECKING
* Check an ccu account
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
CcuAccountChecking {
code (string, optional)
}
{
"code": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type email query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid check data (user or
email)
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /USER/CCU_ACCOUNT
* Update user ccu account attachment
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type Update data
Parameter content type: application/json
body
* Model
* Model Schema
CcuUpdateInput {
token (string, optional)
}
{
"token": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Invalid CCU user token
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER/NOTIF/ROUTECODE/{ROUTECODE}
* retrieve user information for notif by routeCode
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserForNotif {
first_name (string, optional),
last_name (string, optional),
email (string, optional),
title (string, optional),
locale (string, optional)
}
{
"first_name": "string",
"last_name": "string",
"email": "string",
"title": "string",
"locale": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type routeCode
routeCode
path string personalised
personalised
query string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 404 no user found with this
routeCode
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER_CONSENT
* Show/Hide
* List Operations
* Expand Operations
* * GET /USER_CONSENT
* Get user consents
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserConsentDTO {
consents_data (Array[ConsentData]),
updated_at (date-time, optional)
}
ConsentData {
consent_type (string, optional)
}
{
"consents_data": [
{
"consent_type": "string"
}
],
"updated_at": "2024-09-23T11:00:41.836Z"
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER_CONSENT
* Create a user consent
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserConsentDTO {
consents_data (Array[ConsentData]),
updated_at (date-time, optional)
}
ConsentData {
consent_type (string, optional)
}
{
"consents_data": [
{
"consent_type": "string"
}
],
"updated_at": "2024-09-23T11:00:41.836Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
Add user consent
body
* Model
* Model Schema
UserConsentInput {
consent_type (string)
}
{
"consent_type": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 201 Created successfully. 400
Incorrect input values. 409 Trying to add same consent to the same user.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * DELETE /USER_CONSENT/{CONSENT_TYPE}
* Delete a user consent
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserConsentDTO {
consents_data (Array[ConsentData]),
updated_at (date-time, optional)
}
ConsentData {
consent_type (string, optional)
}
{
"consents_data": [
{
"consent_type": "string"
}
],
"updated_at": "2024-09-23T11:00:41.837Z"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type consent_type
Consent Type
path string
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 Deleted successfully. 400
Incorrect input values. 404 Trying to remove an inexistant consent.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /USER_CONSENT/CONSENT_DATA_TEAM/{CONSENT_DATA_TEAM}
* Create a user consent
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type consent_data_team
true false path boolean
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 204 the consentData flag is not a
valid boolean (true or false)
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER_CONSENT/CONSENT_DATA_TEAM
* Returns the consentData status
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
ConsentDataDto {
data_consented (boolean, optional)
}
{
"data_consented": true
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER_MAIL
* Show/Hide
* List Operations
* Expand Operations
* * GET /USER_MAIL/IS_EXISTED
* Check if the input email address is existed
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type email query string
mail_valid true false query booleanccu_linked true false query boolean
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* USER_SECURITY
* Show/Hide
* List Operations
* Expand Operations
* * GET /USER_SECURITY/PAIRING/PIN
* Gets the pin code for the current user pairing
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserSecurityPinData {
value (string, optional),
expired_at (date-time, optional)
}
{
"value": "string",
"expired_at": "2024-09-23T11:00:41.840Z"
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * PUT /USER_SECURITY/2FA
* Update totp or sms status. Only the updated flag has to be provided.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserSecurityData {
sms_enabled (boolean, optional),
totp_enabled (boolean, optional),
two_factor_enabled (boolean, optional)
}
{
"sms_enabled": true,
"totp_enabled": true,
"two_factor_enabled": true
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
UserSecurityTwoFactorInput {
status (boolean, optional),
valid_statuses (boolean, optional),
sms_status (boolean, optional),
totp_status (boolean, optional)
}
{
"status": true,
"valid_statuses": true,
"sms_status": true,
"totp_status": true
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 400 Status may not be null. 403
Action requires reinforced token 409 Inconsistent update status.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER_SECURITY/PAIRING/INIT
* Initialize a pairing for a totp authentication
RESPONSE CLASS (STATUS 200)
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER_SECURITY/PAIRING/STATUS
* Verifie le statut d'un appairage s'il est en cours ou pas
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserSecurityStatusData {
status (boolean, optional)
}
{
"status": true
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * POST /USER_SECURITY/PAIRING/VALIDATE
* Validate the PIN number to finalize a pairing
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserSecurityValidateData {
secret (string, optional)
}
{
"secret": "string"
}
Response Content Type application/json
PARAMETERS
Parameter Value Description Parameter Type Data Type body
Parameter content type: application/json
body
* Model
* Model Schema
TotpInput {
code (string)
}
{
"code": "string"
}
Click to set as parameter value
RESPONSE MESSAGES
HTTP Status Code Reason Response Model 408 Pairing are no more available
for the user 412 Wrong PIN number.
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
* * GET /USER_SECURITY
* Return user security informations.
RESPONSE CLASS (STATUS 200)
* Model
* Model Schema
UserSecurityData {
sms_enabled (boolean, optional),
totp_enabled (boolean, optional),
two_factor_enabled (boolean, optional)
}
{
"sms_enabled": true,
"totp_enabled": true,
"two_factor_enabled": true
}
Response Content Type application/json
Hide Response
REQUEST URL
RESPONSE BODY
RESPONSE CODE
RESPONSE HEADERS
[ BASE URL: /API/V3 , API VERSION: 3 ]
AUTHORIZATION: BEARER
Please use the form below to sign up
Username Password
basic oauth not reconized
Cancel login