https://wiki.safestamper.com/index.php?action=history&feed=atom&title=AuthstateAuthstate - Revision history2026-05-05T03:06:53ZRevision history for this page on the wikiMediaWiki 1.43.1https://wiki.safestamper.com/index.php?title=Authstate&diff=13&oldid=prevAdminwiki: 1 revision imported2023-10-17T11:27:26Z<p>1 revision imported</p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<tr class="diff-title" lang="en">
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 07:27, 17 October 2023</td>
</tr><tr><td colspan="2" class="diff-notice" lang="en"><div class="mw-diff-empty">(No difference)</div>
</td></tr></table>Adminwikihttps://wiki.safestamper.com/index.php?title=Authstate&diff=12&oldid=prevapi>Admin: /* Example */2023-06-05T08:03:25Z<p><span class="autocomment">Example</span></p>
<p><b>New page</b></p><div>This operation checks the status of an authorization key.<br />
<br />
If the authkey is authorized, it also returns information about the authorizing user account.<br />
<br />
= URL =<br />
<nowiki>https://www.safestamper.com/api/authstate</nowiki><br />
<br />
= Parameters =<br />
* '''sharedkey''': Your API client shared key<br />
* '''authkey''': Authkey to check status<br />
* '''signature''': Parameters signature, as explained in [[Signature parameter]]<br />
<br />
= Returns =<br />
<br />
A JSON object with the following fields:<br />
<br />
* '''authkey''': Authkey value<br />
* '''authorized''': State of authkey (true|false).<br />
<br />
If authorized parameter is true the user info is added:<br />
<br />
* '''state''': State of Safe Stamper user (ACTIVE|DISABLED)<br />
* '''userCode''': Safe Stamper code of the authorizing user.<br />
* '''userMail''': Mail of the authorizing user.<br />
* '''userName''': Full name of the authorizing user.<br />
* '''accountType''': Account type of the authorizing user (BASIC|PREMIUM). <br />
* '''userType''': User type of the authorizing user (INDIVIDUAL|ORGANIZATION|OPERATOR). <br />
* '''mainUserAuthkey''': Authkey of main user for authorized operators. <br />
* '''availableCertificates''': Available certification credits to use web static, mail, file and photo services.<br />
* '''availableNavigations''': Available certification credits to use browsing session services.<br />
* '''availableSignedDocuments''': Available signature credits to create signed documents.<br />
* '''availableTimestamps''': Available timestamp credits to use tsa services.<br />
* '''availableDiskSpace''': Available disk space quota<br />
* '''maxCertificateSize''': Máx size in bytes for certificates<br />
* '''maxCertificateSizeMb''': Máx size in MB for certificates<br />
<br />
= HTTP Errors =<br />
<br />
* '''403''' Forbidden: sharedkey or signature are not valid, or the authkey does not belong to the sharedkey<br />
* '''404''' Not found: the authkey does not exist<br />
<br />
= Example =<br />
<br />
REQUEST:<br />
<pre><br />
https://www.safestamper.com/api/authstate<br />
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec<br />
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh<br />
&signature=f9e0222c2fcacbea7923552128a9d395d122e963<br />
</pre><br />
<br />
RESPONSE (actual response has no line breaks or indentation):<br />
<pre><br />
{<br />
"accountType":"PREMIUM",<br />
"authkey":"0021d81c-e4a5-4869-8384-2fd70cdb58ec",<br />
"authorized":true,<br />
"availableCertificates":50,<br />
"availableNavigations":3,<br />
"availableTimestamps":10,<br />
"availableDiskSpace": 113435435<br />
"maxCertificateSize":"22500000"<br />
"maxCertificateSizemB":"15"<br />
"state":"ACTIVE",<br />
"userCode":"1612020000541",<br />
"userMail" : "apitest@safecreative.org",<br />
"userName":"Api User Test"<br />
"userType":"INDIVIDUAL"<br />
}<br />
</pre></div>api>Admin