signdocs-com-br · Schema

EnrollmentRequest

Requisição de enrollment biométrico. Todas as imagens são validadas via DetectFaces para garantir presença de exatamente um rosto. Quando `source` é `DOCUMENT_PHOTO`, o rosto é extraído automaticamente do documento e armazenado como imagem de enrollment. Requer `documentExtractionEnabled` no tenant.

CompanyDigital SignatureBrazilDocument Management

Properties

Name Type Description
dryRun boolean Inspeciona sem gravar. Devolve o mesmo veredito que o endpoint de lote — `usable` / `marginal` / `rejected` com as métricas — e **não persiste nada**: nenhuma imagem no S3, nenhum registro, e o prazo
image string Imagem facial de referência codificada em base64 (JPEG).
cpf string CPF do titular (11 dígitos, sem pontuação).
source string Origem da imagem de enrollment — quem responde por aquele rosto e se o titular estava presente na captura. É o que separa, numa auditoria anos depois, a foto que a organização entregou da captura ao v
View JSON Schema on GitHub

JSON Schema

signdocs-com-br-enrollment-request-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-request-schema.json",
  "title": "EnrollmentRequest",
  "description": "Requisição de enrollment biométrico.\nTodas as imagens são validadas via DetectFaces para garantir presença de exatamente um rosto.\nQuando `source` é `DOCUMENT_PHOTO`, o rosto é extraído automaticamente do documento\ne armazenado como imagem de enrollment. Requer `documentExtractionEnabled` no tenant.\n",
  "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/EnrollmentRequest",
  "type": "object",
  "required": [
    "image",
    "cpf"
  ],
  "properties": {
    "dryRun": {
      "type": "boolean",
      "default": false,
      "description": "Inspeciona sem gravar. Devolve o mesmo veredito que o endpoint de\nlote — `usable` / `marginal` / `rejected` com as métricas — e **não\npersiste nada**: nenhuma imagem no S3, nenhum registro, e o prazo de\n90 dias não começa a correr.\n\nMesma função dos dois lados, de propósito: uma foto não pode ser\njulgada de um jeito no lote e de outro aqui.\n"
    },
    "image": {
      "type": "string",
      "format": "byte",
      "description": "Imagem facial de referência codificada em base64 (JPEG)."
    },
    "cpf": {
      "type": "string",
      "pattern": "^\\d{11}$",
      "description": "CPF do titular (11 dígitos, sem pontuação)."
    },
    "source": {
      "type": "string",
      "description": "Origem da imagem de enrollment — quem responde por aquele rosto e se\no titular estava presente na captura. É o que separa, numa auditoria\nanos depois, a foto que a organização entregou da captura ao vivo e\nda que veio de um documento oficial.\n\n- `ORGANIZATION_PROVIDED` (padrão): foto vinda dos registros da\n  própria organização — crachá, ficha de RH, folha. O titular não\n  estava presente; quem responde pela imagem é a organização.\n- `FIRST_LIVENESS`: imagem capturada na primeira sessão de liveness\n  do titular. Captura ao vivo, com o titular presente.\n- `DOCUMENT_PHOTO`: foto de documento (CNH/RG/passaporte). O rosto é\n  extraído automaticamente. Requer `documentExtractionEnabled`.\n\n`BANK_PROVIDED` continua **aceito** como sinônimo de\n`ORGANIZATION_PROVIDED` e é normalizado na gravação — o valor\ndevolvido e o que vai para a evidência são sempre o canônico. O nome\nantigo é de quando o único cliente era um banco; quem cadastra\noperadores de fábrica não deveria precisar enviá-lo.\n",
      "enum": [
        "ORGANIZATION_PROVIDED",
        "FIRST_LIVENESS",
        "DOCUMENT_PHOTO",
        "BANK_PROVIDED"
      ],
      "default": "ORGANIZATION_PROVIDED"
    }
  }
}

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-request"
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.