Add signature verification API documentation

This commit is contained in:
Yarmo Mackenbach 2021-01-07 16:22:24 +01:00
parent 6c2aa92187
commit a8e0526d59

View file

@ -187,3 +187,31 @@ Parses the `keyPlaintext`.
**Returns**
A public key object.
## signatures.verify(uri, [fingerprint], [opts])
_(async)_ doip.signatures.verify(signature, [opts])
Verifies the identity behind the claims in the provided clear-signed **signature**.
**Parameters**
| Name | Type | Mandatory | Description |
| --------- | ------ | --------- | ------------------------- |
| signature | string | true | the clear-sgned signature |
| opts | object | false | options (see below) |
**Options**
See [claims.verify(uri, ...)](#claimsverifyuri-fingerprint-opts).
**Returns**
```json
{
"errors": [ ... ],
"publicKey": { ... },
"fingerprint": "...",
"serviceproviderData": { ... }
}
```