signdocs-com-br · Schema

EnrollmentStatusResponse

Situação do enrollment biométrico de um usuário.

CompanyDigital SignatureBrazilDocument Management

Properties

Name Type Description
userExternalId string
enrollmentSource string Origem do cadastro em vigor, sempre na forma canônica — enviar `BANK_PROVIDED` devolve `ORGANIZATION_PROVIDED`. Cadastros feitos antes de setembro de 2026 podem devolver `BANK_PROVIDED`.
enrollmentVersion integer Incrementa a cada novo PUT para o mesmo usuário.
enrollmentHash string SHA-256 da imagem de referência em vigor.
enrolledAt string
expiresAt string Momento em que a imagem de referência é apagada pelo ciclo de vida do S3 (`enrolledAt` + `retentionDays`). Depois disso a etapa de comparação falha com 422 até haver novo cadastro.
expired boolean `true` quando `expiresAt` já passou — recadastre. O registro sobrevive à imagem de propósito, por 30 dias, justamente para que uma varredura de recadastramento encontre `expired: true`. Passada essa f
retentionDays integer Janela de retenção de dados biométricos, em dias.
maskedCpf string Últimos 4 dígitos do CPF, prefixados por `***`.
faceConfidence number Confiança da detecção facial no momento do cadastro (0-100).
documentImageHash string Presente apenas em enrollment com `source: DOCUMENT_PHOTO`.
View JSON Schema on GitHub

JSON Schema

signdocs-com-br-enrollment-status-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-enrollment-status-response-schema.json",
  "title": "EnrollmentStatusResponse",
  "description": "Situação do enrollment biométrico de um usuário.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/signdocs-com-br-users-api-openapi.yml#/components/schemas/EnrollmentStatusResponse",
  "type": "object",
  "properties": {
    "userExternalId": {
      "type": "string"
    },
    "enrollmentSource": {
      "type": "string",
      "description": "Origem do cadastro em vigor, sempre na forma canônica — enviar\n`BANK_PROVIDED` devolve `ORGANIZATION_PROVIDED`. Cadastros feitos\nantes de setembro de 2026 podem devolver `BANK_PROVIDED`.\n",
      "enum": [
        "ORGANIZATION_PROVIDED",
        "FIRST_LIVENESS",
        "DOCUMENT_PHOTO",
        "BANK_PROVIDED"
      ]
    },
    "enrollmentVersion": {
      "type": "integer",
      "description": "Incrementa a cada novo PUT para o mesmo usuário."
    },
    "enrollmentHash": {
      "type": "string",
      "description": "SHA-256 da imagem de referência em vigor."
    },
    "enrolledAt": {
      "type": "string",
      "format": "date-time"
    },
    "expiresAt": {
      "type": "string",
      "format": "date-time",
      "description": "Momento em que a imagem de referência é apagada pelo ciclo de vida\ndo S3 (`enrolledAt` + `retentionDays`). Depois disso a etapa de\ncomparação falha com 422 até haver novo cadastro.\n"
    },
    "expired": {
      "type": "boolean",
      "description": "`true` quando `expiresAt` já passou — recadastre.\n\nO registro sobrevive à imagem de propósito, por 30 dias, justamente\npara que uma varredura de recadastramento encontre `expired: true`.\nPassada essa folga o registro também é apagado, e a mesma consulta\npassa a responder 404 — que é indistinguível de \"nunca cadastrado\".\nQuem depende disso deve varrer dentro da folga, não depois.\n"
    },
    "retentionDays": {
      "type": "integer",
      "description": "Janela de retenção de dados biométricos, em dias."
    },
    "maskedCpf": {
      "type": "string",
      "description": "Últimos 4 dígitos do CPF, prefixados por `***`."
    },
    "faceConfidence": {
      "type": "number",
      "format": "double",
      "description": "Confiança da detecção facial no momento do cadastro (0-100)."
    },
    "documentImageHash": {
      "type": "string",
      "description": "Presente apenas em enrollment com `source: DOCUMENT_PHOTO`."
    }
  }
}

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/signdocs-com-br-enrollment-status-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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