This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

Get signers identity report

GET

https://api.signater.com/v1/reports/signers/identity

Last modified:2026-11-04 04:23:46

Summarizes how signers proved who they are in a period of local days: stat cards, signatures per identity factor, failed attempts per factor, outcomes and failures per location, as the app's identity report shows. Filter: vault. Administrators only.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://api.signater.com/v1/reports/signers/identity?vaultId=undefined&fromDate=undefined&toDate=undefined&timeZone=undefined' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Report computed successfully

Bodyapplication/json

Example

{
    "statCards": {
        "signers": 0,
        "withTwoOrMoreFactors": 0,
        "withTwoOrMoreFactorsRate": 0,
        "withFacialBiometrics": 0,
        "failedAttempts": 0,
        "signersWithFailures": 0
    },
    "signedByFactor": [
        {
            "factor": "Password",
            "required": 0,
            "signed": 0
        }
    ],
    "failedAttemptsByFactor": [
        {
            "factor": "Password",
            "attempts": 0
        }
    ],
    "outcomes": {
        "approved": 0,
        "pending": 0,
        "rejected": 0,
        "blocked": 0
    },
    "failuresByLocation": {
        "items": [
            {
                "city": "string",
                "regionCode": "string",
                "country": "string",
                "countryCode": "string",
                "count": 0
            }
        ],
        "otherPlaces": 0,
        "otherCount": 0
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429

Modified at 2026-11-04 04:23:46

Get envelopes report

Get signers notifications report