signdocs-com-br · Schema
CreateTransactionResponse
Resposta de criação de transação.
CompanyDigital SignatureBrazilDocument Management
Properties
| Name | Type | Description |
|---|---|---|
| transactionId | string | Identificador único da transação. |
| status | object | |
| purpose | object | |
| policy | object | |
| steps | array | Etapas de verificação criadas para a transação. |
| userExternalId | string | Identificador externo do usuário. |
| documentHash | string | Hash SHA-256 do documento (presente se documento foi enviado junto). |
| createdAt | string | Data/hora de criação (UTC). |
| expiresAt | string | Data/hora de expiração (UTC). |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/signdocs-com-br/json-schema/signdocs-com-br-create-transaction-response-schema.json",
"title": "CreateTransactionResponse",
"description": "Resposta de criação de transação.",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/signdocs-com-br-transactions-api-openapi.yml#/components/schemas/CreateTransactionResponse",
"type": "object",
"required": [
"transactionId",
"status",
"purpose",
"policy",
"steps",
"userExternalId",
"createdAt"
],
"properties": {
"transactionId": {
"type": "string",
"description": "Identificador único da transação."
},
"status": {
"$ref": "#/$defs/TransactionStatus"
},
"purpose": {
"$ref": "#/$defs/TransactionPurpose"
},
"policy": {
"$ref": "#/$defs/Policy"
},
"steps": {
"type": "array",
"description": "Etapas de verificação criadas para a transação.",
"items": {
"type": "object",
"required": [
"stepId",
"type",
"status",
"order"
],
"properties": {
"stepId": {
"type": "string"
},
"type": {
"$ref": "#/$defs/StepType"
},
"status": {
"$ref": "#/$defs/StepStatus"
},
"order": {
"type": "integer"
}
}
}
},
"userExternalId": {
"type": "string",
"description": "Identificador externo do usuário."
},
"documentHash": {
"type": "string",
"description": "Hash SHA-256 do documento (presente se documento foi enviado junto)."
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Data/hora de criação (UTC)."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"description": "Data/hora de expiração (UTC)."
}
},
"$defs": {
"Policy": {
"type": "object",
"description": "Política de verificação de identidade da transação.",
"required": [
"profile"
],
"properties": {
"profile": {
"$ref": "#/$defs/PolicyProfile"
},
"customSteps": {
"type": "array",
"description": "Etapas customizadas (apenas quando `profile` = `CUSTOM`).",
"items": {
"$ref": "#/$defs/StepType"
}
},
"minSimilarity": {
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 100,
"description": "Limiar mínimo de similaridade facial exigido desta transação, para as\netapas `BIOMETRIC_MATCH` e `DOCUMENT_PHOTO_MATCH`.\n\n**Só aperta, nunca afrouxa.** O valor precisa ser maior ou igual ao\nlimiar configurado para o tenant; um valor abaixo dele retorna 400\ninformando o mínimo vigente, em vez de ser ignorado em silêncio —\nafrouxar a verificação de identidade é decisão do tenant, não da\nrequisição. Documentos de maior risco podem assim exigir mais\nconfiança que o padrão da conta, sem reconfigurar o tenant.\n\nAceita tanto percentual (`95`) quanto fração (`0.95`).\n"
},
"minLivenessConfidence": {
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 100,
"description": "Limiar mínimo de confiança de vivacidade (`BIOMETRIC_LIVENESS`) exigido\ndesta transação. Mesmo enquadramento do `minSimilarity`: só aperta, e\num valor abaixo do mínimo do tenant retorna 400.\n\nQuando o tenant não define limiar de vivacidade próprio, qualquer valor\nválido é aceito.\n"
}
}
},
"PolicyProfile": {
"type": "string",
"description": "Perfis de política de verificação pré-definidos. Cada perfil resolve para uma\nlista ordenada de etapas (`StepType`):\n\n- `CLICK_ONLY`: CLICK_ACCEPT\n- `CLICK_PLUS_OTP`: CLICK_ACCEPT, OTP_CHALLENGE, OTP_VERIFY\n- `BIOMETRIC`: BIOMETRIC_LIVENESS, BIOMETRIC_MATCH\n- `BIOMETRIC_PLUS_OTP`: BIOMETRIC_LIVENESS, BIOMETRIC_MATCH, OTP_CHALLENGE, OTP_VERIFY\n- `DIGITAL_CERTIFICATE`: CLICK_ACCEPT, DIGITAL_SIGN_A1\n- `BIOMETRIC_SERPRO`: BIOMETRIC_LIVENESS, BIOMETRIC_MATCH, SERPRO_IDENTITY_CHECK\n- `BIOMETRIC_SERPRO_AUTO_FALLBACK`: as mesmas etapas de `BIOMETRIC_SERPRO`, mais uma\n etapa DOCUMENT_PHOTO_MATCH criada em estado `DORMANT`. Se a base governamental\n estiver indisponível, a etapa SERPRO passa a `SKIPPED` e a dormente é ativada,\n sem derrubar a assinatura em andamento.\n- `BIOMETRIC_DOCUMENT_FALLBACK`: BIOMETRIC_LIVENESS, DOCUMENT_PHOTO_MATCH — para\n signatários sem cadastro biométrico prévio, comparando a prova de vida com a foto\n de um documento oficial.\n- `CUSTOM`: etapas definidas em `policy.customSteps`.\n\n`BIOMETRIC`, `BIOMETRIC_PLUS_OTP`, `BIOMETRIC_SERPRO`, `BIOMETRIC_SERPRO_AUTO_FALLBACK`\ne `BIOMETRIC_DOCUMENT_FALLBACK` exigem cota biométrica provisionada para o tenant.\n",
"enum": [
"CLICK_ONLY",
"CLICK_PLUS_OTP",
"BIOMETRIC",
"BIOMETRIC_PLUS_OTP",
"DIGITAL_CERTIFICATE",
"BIOMETRIC_SERPRO",
"BIOMETRIC_SERPRO_AUTO_FALLBACK",
"BIOMETRIC_DOCUMENT_FALLBACK",
"CUSTOM"
]
},
"StepStatus": {
"type": "string",
"description": "Status possíveis de uma etapa. `SKIPPED` e `DORMANT` aparecem nos perfis com\nfallback: a etapa dormente é criada junto com a transação e só entra em `PENDING`\nse a etapa que ela substitui for pulada.\n",
"enum": [
"PENDING",
"STARTED",
"COMPLETED",
"FAILED",
"SKIPPED",
"DORMANT"
]
},
"StepType": {
"type": "string",
"description": "Tipos de etapa de verificação de identidade. Em `policy.customSteps` a ordem é\nvalidada na criação: BIOMETRIC_MATCH, SERPRO_IDENTITY_CHECK e DOCUMENT_PHOTO_MATCH\nexigem BIOMETRIC_LIVENESS antes de si, OTP_CHALLENGE e OTP_VERIFY vêm sempre em par\ne nessa ordem, e DIGITAL_SIGN_A1 tem de ser a última etapa.\n",
"enum": [
"CLICK_ACCEPT",
"OTP_CHALLENGE",
"OTP_VERIFY",
"BIOMETRIC_LIVENESS",
"BIOMETRIC_MATCH",
"DOCUMENT_PHOTO_MATCH",
"SERPRO_IDENTITY_CHECK",
"DIGITAL_SIGN_A1",
"PURPOSE_DISCLOSURE"
]
},
"TransactionPurpose": {
"type": "string",
"description": "Finalidade da transação.",
"enum": [
"DOCUMENT_SIGNATURE",
"ACTION_AUTHENTICATION"
]
},
"TransactionStatus": {
"type": "string",
"description": "Status possíveis de uma transação.",
"enum": [
"CREATED",
"DOCUMENT_UPLOADED",
"IN_PROGRESS",
"COMPLETED",
"CANCELLED",
"EXPIRED",
"FAILED"
]
}
}
}
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-create-transaction-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.