Signicat · Schema

Authentication

CompanyDigital IdentityAuthenticationE-SignatureKYCIdentity VerificationeIDFraud Prevention

Properties

Name	Type	Description
errorCode	string	The error code given if the operation fails. See [operation error codes](/apis/mobileid/#section/Common-concepts/Operation-error-codes) for possible values.
errorDescription	string	The descriptive error message given if the operation fails.
riskAttributes	object	The risk attributes collected for the device. See [risk attributes](/apis/mobileid/#section/Common-concepts/Risk-attributes) for possible values. You can find out how to configure which attributes are
accountId	string	The ID of the account for which the operation is executed.
transactionId	string	The ID of the transaction.
state	string	The operation state. See [operation state](/apis/mobileid/#section/Common-concepts/Operation-states) for possible values.
created	string	The timestamp when initial response was created. Returned in pattern `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
completed	string	The timestamp when the operation was completed. Returned in pattern `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.
device	object	The device object.
user	object	The user object.
tags	array	Used to tag callback event to enable filtering.
operationProperties	object	An object that describes the properties used to carry out the operation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/signicat/main/json-schema/signicat-authentication-schema.json",
  "title": "Authentication",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/signicat-mobileid-openapi.yml#/components/schemas/Authentication",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "errorCode": {
      "type": "string",
      "additionalProperties": false,
      "description": "The error code given if the operation fails. \n\n See [operation error codes](/apis/mobileid/#section/Common-concepts/Operation-error-codes) for possible values."
    },
    "errorDescription": {
      "type": "string",
      "additionalProperties": false,
      "description": "The descriptive error message given if the operation fails."
    },
    "riskAttributes": {
      "type": "object",
      "additionalProperties": false,
      "description": "The risk attributes collected for the device.\n\nSee [risk attributes](/apis/mobileid/#section/Common-concepts/Risk-attributes) for possible values.\n\nYou can find out how to configure which attributes are collected in the <a href=\"https://developer.signicat.com/docs/mobile-identity/mobileid/features/application-configuration#risk-data\" target=\"_blank\">application configuration</a> feature documentation.\n"
    },
    "accountId": {
      "type": "string",
      "additionalProperties": false,
      "description": "The ID of the account for which the operation is executed."
    },
    "transactionId": {
      "type": "string",
      "additionalProperties": false,
      "description": "The ID of the transaction."
    },
    "state": {
      "type": "string",
      "additionalProperties": false,
      "description": "The operation state. \n\n See [operation state](/apis/mobileid/#section/Common-concepts/Operation-states) for possible values."
    },
    "created": {
      "type": "string",
      "additionalProperties": false,
      "description": "The timestamp when initial response was created. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
    },
    "completed": {
      "type": "string",
      "additionalProperties": false,
      "description": "The timestamp when the operation was completed. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
    },
    "device": {
      "$ref": "#/$defs/Device",
      "additionalProperties": false,
      "description": "The device object."
    },
    "user": {
      "$ref": "#/$defs/User",
      "additionalProperties": false,
      "description": "The user object."
    },
    "tags": {
      "type": "array",
      "additionalProperties": false,
      "description": "Used to tag callback event to enable filtering.",
      "items": {
        "type": "string",
        "additionalProperties": false
      }
    },
    "operationProperties": {
      "$ref": "#/$defs/AuthenticationOperationProperties",
      "additionalProperties": false,
      "description": "An object that describes the properties used to carry out the operation."
    }
  },
  "$defs": {
    "AccountRecovery": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "recoveryId": {
          "type": "string",
          "additionalProperties": false,
          "description": "The ID of the recovery."
        },
        "recoveryMethod": {
          "type": "string",
          "additionalProperties": false,
          "description": "The recovery method used for the recovery. \n\n See [recovery methods](/apis/mobileid/#section/Common-concepts/Recovery-methods) for possible values."
        },
        "recoveryStatus": {
          "type": "string",
          "additionalProperties": false,
          "description": "The status of the recovery. \n\n See [recovery statuses](/apis/mobileid/#section/Common-concepts/Recovery-statuses) for possible values."
        },
        "created": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the recovery was created. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
        },
        "modified": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the recovery was updated. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
        },
        "recovered": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the recovery was used. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
        }
      }
    },
    "AppAttestation": {
      "type": "object",
      "additionalProperties": false,
      "description": "An object that describes the properties of the attestation. \n\n In order for this object to be returned in response, it has to be enabled in the <a href=\"https://developer.signicat.com/docs/mobile-identity/mobileid/features/application-configuration#app-attestation\" target=\"_blank\">application configuration</a>.",
      "properties": {
        "playIntegrityStatus": {
          "type": "string",
          "additionalProperties": false,
          "description": "The Play Integrity attestation status for the user's device. \n\n See [Play Integrity statuses](/apis/mobileid/#section/Common-concepts/Play-Integrity-statuses) for possible values."
        },
        "playIntegrityDate": {
          "type": "string",
          "additionalProperties": false,
          "description": "The date when the Play Integrity attestation was performed on the user's device."
        },
        "appAttestStatus": {
          "type": "string",
          "additionalProperties": false,
          "description": "The App Attest attestation status for the user's device. \n\n See [App Attest statuses](/apis/mobileid/#section/Common-concepts/App-Attest-statuses) for possible values."
        },
        "appAttestDate": {
          "type": "string",
          "additionalProperties": false,
          "description": "The date when the App Attest attestation was performed on the user's device."
        }
      }
    },
    "AuthenticationOperationProperties": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "authMethod": {
          "type": "string",
          "additionalProperties": false,
          "description": "The authentication method to use for the operation.\n\nSee [authentication methods](/apis/mobileid/#section/Common-concepts/Authentication-methods) for possible values.\n\nIf not provided, the user will be able to choose between all configured authentication methods supported on the device, except for server-side face authentication (<code>DEVICE_SERVER_SIDE_FACE</code>) which must be passed explicitly as the authentication method.\n"
        },
        "authLevel": {
          "type": "string",
          "additionalProperties": false,
          "description": "The authentication level to use for the operation. \n\n If not provided, the default authentication level <code>TWO_FACTOR</code> will be used. \n\n See [authentication levels](/apis/mobileid/#section/Common-concepts/Authentication-levels) for possible values."
        },
        "pushPayload": {
          "type": "string",
          "additionalProperties": false,
          "description": "A custom payload that is sent to the end-user’s device in the push notification.\n\nThe custom payload is sent in plain text, and all characters must be in the Basic Multilingual Plane (BMP).\n\nData requiring a secure channel should use the post-operation context and the pre-operation context, as the push channel is not secure.\n"
        },
        "broadcast": {
          "type": "boolean",
          "additionalProperties": false,
          "description": "Choose whether to broadcast the operation to all of the user's active devices or not.\n\nThe default is <code>false</code>. To enable broadcast, you must set this property to <code>true</code>.\n\nIf broadcast is enabled:\n<ul><li>The device object in the operation request should either be empty, or it should not be supplied entirely.\n<li>Consider whether or not you supply `authMethod` in the request. Only devices that support the specified authentication method receive the broadcast, which means that you may limit the devices that can be used by supplying this.</li></ul>\n\n"
        },
        "preOperationContext": {
          "$ref": "#/$defs/preOperationContext",
          "additionalProperties": false
        },
        "postOperationContext": {
          "$ref": "#/$defs/postOperationContext",
          "additionalProperties": false
        },
        "sendPush": {
          "type": "boolean",
          "additionalProperties": false,
          "description": "Choose whether to send push or not.\n\nIn order to be sent, it requires that push notifications are configured in your <a href=\"https://developer.signicat.com/docs/mobile-identity/mobileid/features/application-configuration#push-notifications\" target=\"_blank\">application configuration</a>.\n\nIf not specified, then push notifications will be sent depending on the settings in your application configuration.\n"
        },
        "sessionTimeout": {
          "type": "string",
          "additionalProperties": false,
          "description": "The duration after which the operation will timeout, given in milliseconds. \n\n This value cannot exceed the maximum configured value of <code>18720000</code>."
        },
        "metadata": {
          "type": "string",
          "additionalProperties": false,
          "description": "The metadata for the operation. \n\n This is an optional parameter, used for sending metadata. \n\n The value is never changed, and is returned in the operation response. \n\n This value cannot exceed the maximum possible length of 1024 characters."
        },
        "clientData": {
          "type": "string",
          "additionalProperties": false,
          "description": "The data that the client application optionally passed at the point of the authentication."
        },
        "requestedUserAttributes": {
          "type": "array",
          "additionalProperties": false,
          "contains": {
            "additionalProperties": false
          },
          "description": "User attributes to be returned.\n\nIf empty, the user object returned after a successful operation will not include any attributes.\n\nNon-existent user attributes will be silently ignored.",
          "items": {
            "type": "string",
            "additionalProperties": false
          },
          "unevaluatedItems": {
            "additionalProperties": false
          }
        },
        "attestation": {
          "$ref": "#/$defs/AppAttestation",
          "additionalProperties": false
        },
        "location": {
          "$ref": "#/$defs/Location",
          "additionalProperties": false,
          "description": "An object that describes the location of the device used for the operation. \n\n In order to be returned in the response, it has to be enabled in the <a href=\"https://developer.signicat.com/docs/mobile-identity/mobileid/features/application-configuration#risk-data\" target=\"_blank\">application configuration</a>."
        },
        "pushSent": {
          "type": "boolean",
          "additionalProperties": false,
          "description": "Informs you whether a push notification is sent or not."
        },
        "geofencing": {
          "$ref": "#/$defs/Geofencing",
          "additionalProperties": false
        },
        "sessionExpiryTime": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the operation expires. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
        }
      }
    },
    "Device": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": "string",
          "additionalProperties": false,
          "description": "The ID of the user's device (<code>deviceId</code>)."
        },
        "name": {
          "type": "string",
          "additionalProperties": false,
          "description": "The name of the user's device."
        },
        "state": {
          "type": "string",
          "additionalProperties": false,
          "description": "The state of the user's device. \n\n This is returned as an enum, and can be either <code>ACTIVE</code>, <code>LOCKED</code> or <code>DELETED</code>.",
          "enum": [
            "ACTIVE",
            "LOCKED",
            "DELETED"
          ]
        },
        "lastOperationType": {
          "type": "string",
          "additionalProperties": false,
          "description": "The last operation type that the user's device executed. \n\n See [operation type](/apis/mobileid/#section/Common-concepts/Operation-types) for possible values."
        },
        "lastUsed": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the user's device last executed an operation. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
        },
        "created": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the user's device was originally activated. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>."
        },
        "deviceDetails": {
          "$ref": "#/$defs/DeviceDetails",
          "additionalProperties": false,
          "description": "The device details object."
        }
      }
    },
    "DeviceDetails": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "lock": {
          "$ref": "#/$defs/DeviceLock",
          "additionalProperties": false,
          "description": "An object that contains details about the device lock. \n\n This object is only supplied when the user's device is locked."
        },
        "activationTime": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the user's device was originally activated.",
          "readOnly": true
        },
        "deviceHash": {
          "type": "string",
          "additionalProperties": false,
          "description": "A SHA256 hash of the unique hardware device ID of the user's device.",
          "readOnly": true
        },
        "applicationId": {
          "type": "string",
          "additionalProperties": false,
          "description": "The application ID being used for the device.",
          "readOnly": true
        },
        "currentClientApiVersion": {
          "type": "string",
          "additionalProperties": false,
          "description": "The Encap client API version that the user's device used for its last operation."
        },
        "activatedClientApiVersion": {
          "type": "string",
          "additionalProperties": false,
          "description": "The Encap client API version that the user's device was originally activated on."
        },
        "activatedEncapRelease": {
          "type": "string",
          "additionalProperties": false,
          "description": "The Encap server release version that the user's device was originally activated on.",
          "readOnly": true
        },
        "pushAddress": {
          "type": "string",
          "additionalProperties": false,
          "description": "The push address for the user's device. \n\n This address is used when sending a push to the device using Firebase Cloud Messaging (FCM) or Apple Push Notification Service (APNS).",
          "readOnly": true
        },
        "operatingSystemType": {
          "type": "string",
          "additionalProperties": false,
          "description": "The operating system type of the user's device.",
          "readOnly": true
        },
        "activatedAuthenticationMethods": {
          "type": "array",
          "additionalProperties": false,
          "description": "A list of the activated authentication methods for the user's device. \n\n See [authentication methods](/apis/mobileid/#section/Common-concepts/Authentication-methods) for possible values.",
          "items": {
            "type": "string",
            "additionalProperties": false
          },
          "readOnly": true
        },
        "attestation": {
          "$ref": "#/$defs/AppAttestation",
          "additionalProperties": false
        },
        "recoveries": {
          "type": "array",
          "additionalProperties": false,
          "description": "A list that contains all of the recoveries for a user's device.",
          "items": {
            "$ref": "#/$defs/AccountRecovery",
            "additionalProperties": false
          }
        },
        "recoveryLock": {
          "type": "boolean",
          "additionalProperties": false,
          "description": "A setting for a user's device which indicates whether the account recovery feature is enabled or not.<ul><li>When <code>false</code>, the account recovery feature is enabled and recovery operations can be performed.</li><li>When <code>true</code>, the account recovery feature is disabled and recovery operations cannot be performed.</li></ul>"
        }
      }
    },
    "DeviceLock": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "lockReason": {
          "type": "array",
          "additionalProperties": false,
          "description": "A list that contains all reasons why the user's device has been locked. \n\n See [Lock reason](/apis/mobileid/#section/Common-concepts/Lock-reason) for possible values.",
          "items": {
            "type": "string",
            "additionalProperties": false
          },
          "readOnly": true
        }
      }
    },
    "Geofencing": {
      "type": "object",
      "additionalProperties": false,
      "description": "An object that contains details of the geofencing validation.\n\nIn order for this object to be returned in the response, it has to be enabled in the <a href=\"https://developer.signicat.com/docs/mobile-identity/mobileid/features/application-configuration#geofencing\" target=\"_blank\">application configuration</a>.\n",
      "properties": {
        "countryCode": {
          "type": "string",
          "additionalProperties": false,
          "description": "The country code in an ISO 3166-1 Alpha-2 format, as reported by the SDK.\n\nYou can find a list of countries and corresponding codes at [GeoNames](https://www.geonames.org/countries/).\n"
        },
        "clientStatus": {
          "type": "string",
          "additionalProperties": false,
          "description": "The status of the geofencing operation, as reported by the SDK.\n\nSee [Geofencing client statuses](/apis/mobileid/#section/Common-concepts/Geofencing-client-statuses) for possible values.\n"
        },
        "serverBoundaryValidation": {
          "type": "string",
          "additionalProperties": false,
          "description": "The status of the geofencing server validation, after evaluating the country against the allowed region.\n\nSee [Geofencing server boundary validation statuses](/apis/mobileid/#section/Common-concepts/Geofencing-server-boundary-validation-statuses) for possible values.\n"
        }
      }
    },
    "Location": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "accuracy": {
          "type": "string",
          "additionalProperties": false,
          "description": "The location accuracy of the device used for the operation."
        },
        "altitude": {
          "type": "string",
          "additionalProperties": false,
          "description": "The location altitude of the device used for the operation."
        },
        "latitude": {
          "type": "string",
          "additionalProperties": false,
          "description": "The location latitude of the device used for the operation."
        },
        "longitude": {
          "type": "string",
          "additionalProperties": false,
          "description": "The location longitude of the device used for the operation."
        }
      }
    },
    "User": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "externalRef": {
          "type": "string",
          "additionalProperties": false,
          "description": "An identifier generated by you (the customer), that points to the user ID (<code>userId</code>) generated by MobileID when a new user is created.\n"
        },
        "segment": {
          "type": "string",
          "additionalProperties": false,
          "description": "A parameter used for segmentation of end-users and their corresponding transactions.\n"
        },
        "id": {
          "type": "string",
          "additionalProperties": false,
          "description": "The ID of the user (<code>userId</code>), in a valid UUID format."
        },
        "created": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the user was created. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>. \n\n"
        },
        "lastUsed": {
          "type": "string",
          "additionalProperties": false,
          "description": "The timestamp when the user last executed any <code>REGISTRATION</code>, <code>AUTHENTICATION</code> or <code>SIGNATURE</code> operation. \n\n Returned in pattern <code>yyyy-MM-dd'T'HH:mm:ss.SSSZ</code>. \n\n"
        },
        "state": {
          "type": "string",
          "additionalProperties": false,
          "description": "The state of the user. \n\n This is returned as an enum, and can be either <code>ACTIVE</code> or <code>LOCKED</code>.",
          "enum": [
            "ACTIVE",
            "LOCKED"
          ]
        },
        "attributes": {
          "type": "object",
          "additionalProperties": false,
          "description": "The user attributes, given as key-value pairs.\n"
        }
      }
    },
    "postOperationContext": {
      "additionalProperties": false,
      "description": "The post-operation context.<br /><br /> The context sent to the app, through a secure end-to-end encrypted channel, **only after** the operation is successfully completed.<br /><br /> For the maximum character length of the operation context content (`content`), see [Operation context maximum character length](#section/Common-concepts/Operation-context-maximum-character-length).<br /><br /> For more information, see our [Operation context](https://developer.signicat.com/docs/mobile-identity/mobileid/features/operation-context) feature documentation.",
      "properties": {
        "title": {
          "type": "string",
          "additionalProperties": false,
          "description": "The title of the context"
        },
        "content": {
          "type": "string",
          "additionalProperties": false,
          "description": "The content of the context"
        },
        "mimeType": {
          "type": "string",
          "additionalProperties": false,
          "description": "The mime type of the content"
        }
      },
      "required": [
        "content",
        "mimeType"
      ]
    },
    "preOperationContext": {
      "additionalProperties": false,
      "description": "The pre-operation context.<br /><br /> The context sent to the app, through a secure end-to-end encrypted channel, **before** the operation is completed.<br /><br /> For the maximum character length of the operation context content (`content`), see [Operation context maximum character length](#section/Common-concepts/Operation-context-maximum-character-length).<br /><br /> For more information, see our [Operation context](https://developer.signicat.com/docs/mobile-identity/mobileid/features/operation-context) feature documentation.",
      "properties": {
        "title": {
          "type": "string",
          "additionalProperties": false,
          "description": "The title of the context"
        },
        "content": {
          "type": "string",
          "additionalProperties": false,
          "description": "The content of the context"
        },
        "mimeType": {
          "type": "string",
          "additionalProperties": false,
          "description": "The mime type of the content"
        }
      },
      "required": [
        "content",
        "mimeType"
      ]
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/signicat-authentication"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.