signdocs-com-br · Schema
EnrollmentResponse
Resposta de enrollment biométrico.
CompanyDigital SignatureBrazilDocument Management
Properties
| Name | Type | Description |
|---|---|---|
| userExternalId | string | |
| enrollmentHash | string | Hash SHA-256 da imagem de enrollment (face crop quando DOCUMENT_PHOTO). |
| enrollmentVersion | integer | Versão do enrollment (incrementada a cada atualização). |
| enrollmentSource | string | Origem do enrollment. |
| enrolledAt | string | |
| cpf | string | CPF do titular. |
| faceConfidence | number | Confiança da detecção facial (0-100%). |
| documentImageHash | string | Hash SHA-256 do documento original. Presente apenas quando `enrollmentSource` é `DOCUMENT_PHOTO`. |
| referenceQuality | string | **A foto serve como referência?** É este o campo a ler — não deduza do array `warnings`. `usable` limpa; `marginal` guardou normalmente mas é referência fraca; `rejected` não seria guardada. Numa grav |
| quality | object | Medidas do Rekognition para o rosto detectado (0-100), da mesma chamada `DetectFaces` que o cadastro já faz. **`faceConfidence` sozinho engana aqui:** ele responde "isto é um rosto?", e uma foto escur |
| pose | object | Rotação da cabeça em graus. |
| faceCoverage | number | Área do rosto como fração do quadro (0-1). |
| warnings | array | Ressalvas de qualidade. Vêm também numa gravação bem-sucedida — a foto é guardada de qualquer jeito, e é melhor saber que ela é fraca agora do que por uma assinatura reprovada daqui a três meses. Arra |
| extractionConfidence | number | Confiança da extração facial do documento. Presente apenas quando `enrollmentSource` é `DOCUMENT_PHOTO`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-enrollment-response-schema.json",
"title": "EnrollmentResponse",
"description": "Resposta de enrollment biométrico.",
"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/EnrollmentResponse",
"type": "object",
"required": [
"userExternalId",
"enrollmentHash",
"enrollmentVersion",
"enrollmentSource",
"enrolledAt",
"cpf",
"faceConfidence"
],
"properties": {
"userExternalId": {
"type": "string"
},
"enrollmentHash": {
"type": "string",
"description": "Hash SHA-256 da imagem de enrollment (face crop quando DOCUMENT_PHOTO)."
},
"enrollmentVersion": {
"type": "integer",
"description": "Versão do enrollment (incrementada a cada atualização)."
},
"enrollmentSource": {
"type": "string",
"description": "Origem do enrollment.",
"enum": [
"BANK_PROVIDED",
"FIRST_LIVENESS",
"DOCUMENT_PHOTO"
]
},
"enrolledAt": {
"type": "string",
"format": "date-time"
},
"cpf": {
"type": "string",
"description": "CPF do titular."
},
"faceConfidence": {
"type": "number",
"description": "Confiança da detecção facial (0-100%)."
},
"documentImageHash": {
"type": "string",
"description": "Hash SHA-256 do documento original. Presente apenas quando `enrollmentSource` é `DOCUMENT_PHOTO`."
},
"referenceQuality": {
"type": "string",
"enum": [
"usable",
"marginal",
"rejected"
],
"description": "**A foto serve como referência?** É este o campo a ler — não deduza\ndo array `warnings`.\n\n`usable` limpa; `marginal` guardou normalmente mas é referência\nfraca; `rejected` não seria guardada. Numa gravação bem-sucedida só\naparecem `usable` e `marginal`.\n\nDeliberadamente **não** é o `status`: no lote, `status` diz o que\naconteceu com a gravação (`enrolled`/`failed`), que é outra pergunta.\nUma foto ruim que gravou bem é `status: enrolled` com\n`referenceQuality: marginal` — e é essa a combinação que interessa.\n\nÉ o mesmo campo que o `dryRun` devolve, então um único trecho de\ncódigo julga a foto tenha ela vindo de qual chamada for.\n"
},
"quality": {
"type": "object",
"description": "Medidas do Rekognition para o rosto detectado (0-100), da mesma\nchamada `DetectFaces` que o cadastro já faz.\n\n**`faceConfidence` sozinho engana aqui:** ele responde \"isto é um\nrosto?\", e uma foto escura e tremida marca 99,99 nele sendo uma\nreferência ruim. São estes números que preveem se a comparação vai\nfuncionar.\n",
"properties": {
"brightness": {
"type": "number",
"format": "double"
},
"sharpness": {
"type": "number",
"format": "double"
}
}
},
"pose": {
"type": "object",
"description": "Rotação da cabeça em graus.",
"properties": {
"yaw": {
"type": "number",
"format": "double"
},
"pitch": {
"type": "number",
"format": "double"
},
"roll": {
"type": "number",
"format": "double"
}
}
},
"faceCoverage": {
"type": "number",
"format": "double",
"description": "Área do rosto como fração do quadro (0-1)."
},
"warnings": {
"type": "array",
"description": "Ressalvas de qualidade. Vêm também numa gravação bem-sucedida — a\nfoto é guardada de qualquer jeito, e é melhor saber que ela é fraca\nagora do que por uma assinatura reprovada daqui a três meses.\nArray vazio quando não há ressalva.\n",
"items": {
"type": "string",
"enum": [
"LOW_BRIGHTNESS",
"LOW_SHARPNESS",
"FACE_TOO_SMALL",
"HEAD_TURNED"
]
}
},
"extractionConfidence": {
"type": "number",
"description": "Confiança da extração facial do documento. Presente apenas quando `enrollmentSource` é `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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/signdocs-com-br-enrollment-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.