Referência da API
Gerada a partir do catálogo de rotas que os testes validam contra o servidor.
Auth
post/v1/auth/registerCria uma conta de usuário
Autenticação: Público
{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 200
},
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
}
},
"required": [
"email",
"password",
"name"
],
"additionalProperties": false
}post/v1/auth/loginAutentica com e-mail e senha
Autenticação: Público
{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"password": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"required": [
"email",
"password"
],
"additionalProperties": false
}post/v1/auth/mfa/verifyConclui o login com o segundo fator
Autenticação: Público
{
"type": "object",
"properties": {
"challenge": {
"type": "string",
"minLength": 10,
"maxLength": 200
},
"code": {
"type": "string",
"minLength": 6,
"maxLength": 20
}
},
"required": [
"challenge",
"code"
],
"additionalProperties": false
}post/v1/auth/refreshRotaciona a sessão
Autenticação: Público
post/v1/auth/logoutEncerra a sessão atual
Autenticação: Sessão do console
post/v1/auth/logout-allEncerra todas as sessões
Autenticação: Sessão do console
get/v1/auth/meUsuário e organizações
Autenticação: Sessão do console
post/v1/auth/verify-emailConfirma o e-mail
Autenticação: Público
{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 10,
"maxLength": 300
}
},
"required": [
"token"
],
"additionalProperties": false
}post/v1/auth/forgot-passwordSolicita redefinição de senha
Autenticação: Público
{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
}
},
"required": [
"email"
],
"additionalProperties": false
}post/v1/auth/reset-passwordRedefine a senha
Autenticação: Público
{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 10,
"maxLength": 300
},
"password": {
"type": "string",
"minLength": 12,
"maxLength": 200
}
},
"required": [
"token",
"password"
],
"additionalProperties": false
}post/v1/auth/change-passwordAltera a senha
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"currentPassword": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"newPassword": {
"type": "string",
"minLength": 12,
"maxLength": 200
}
},
"required": [
"currentPassword",
"newPassword"
],
"additionalProperties": false
}get/v1/auth/sessionsLista sessões ativas
Autenticação: Sessão do console
delete/v1/auth/sessions/{id}Revoga uma sessão
Autenticação: Sessão do console
get/v1/auth/login-historyHistórico de acesso
Autenticação: Sessão do console
get/v1/auth/mfaEstado do MFA
Autenticação: Sessão do console
post/v1/auth/mfa/enrollInicia a ativação de TOTP
Autenticação: Sessão do console
post/v1/auth/mfa/confirmConfirma a ativação de TOTP
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 6,
"maxLength": 20
}
},
"required": [
"code"
],
"additionalProperties": false
}post/v1/auth/mfa/disableDesativa o TOTP
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"code": {
"type": "string",
"minLength": 6,
"maxLength": 20
}
},
"required": [
"password",
"code"
],
"additionalProperties": false
}post/v1/auth/mfa/email/sendReenvia o código de login por e-mail
Autenticação: Público
{
"type": "object",
"properties": {
"challenge": {
"type": "string",
"minLength": 10,
"maxLength": 200
}
},
"required": [
"challenge"
],
"additionalProperties": false
}post/v1/auth/mfa/email/enrollEnvia o código para ativar o MFA por e-mail
Autenticação: Sessão do console
post/v1/auth/mfa/email/confirmConfirma a ativação do MFA por e-mail
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"code": {
"type": "string",
"minLength": 6,
"maxLength": 20
}
},
"required": [
"code"
],
"additionalProperties": false
}post/v1/auth/mfa/email/requestEnvia um código para confirmar uma ação da conta
Autenticação: Sessão do console
post/v1/auth/mfa/email/disableDesativa o MFA por e-mail
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"password": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"code": {
"type": "string",
"minLength": 6,
"maxLength": 20
}
},
"required": [
"password",
"code"
],
"additionalProperties": false
}Organizations
post/v1/organizationsCria uma organização
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"taxId": {
"type": "string",
"maxLength": 20
}
},
"required": [
"name"
],
"additionalProperties": false
}get/v1/organizations/currentOrganização atual
Autenticação: Sessão do console
Permissão: org:read
patch/v1/organizations/currentAtualiza a organização
Autenticação: Sessão do console
Permissão: org:write
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"taxId": {
"anyOf": [
{
"type": "string",
"maxLength": 20
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}post/v1/organizations/current/production-accessSolicita acesso a produção
Autenticação: Sessão do console
Permissão: org:write
get/v1/organizations/current/membersLista membros
Autenticação: Sessão do console
Permissão: members:read
patch/v1/organizations/current/members/{id}Altera o papel de um membro
Autenticação: Sessão do console
Permissão: members:write
{
"type": "object",
"properties": {
"roleKey": {
"type": "string",
"maxLength": 40
}
},
"required": [
"roleKey"
],
"additionalProperties": false
}delete/v1/organizations/current/members/{id}Remove um membro
Autenticação: Sessão do console
Permissão: members:write
get/v1/organizations/current/invitesLista convites
Autenticação: Sessão do console
Permissão: members:read
post/v1/organizations/current/invitesConvida um membro
Autenticação: Sessão do console
Permissão: members:write
{
"type": "object",
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"roleKey": {
"type": "string",
"maxLength": 40
}
},
"required": [
"email",
"roleKey"
],
"additionalProperties": false
}delete/v1/organizations/current/invites/{id}Revoga um convite
Autenticação: Sessão do console
Permissão: members:write
post/v1/organizations/invites/acceptAceita um convite
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 10,
"maxLength": 300
}
},
"required": [
"token"
],
"additionalProperties": false
}get/v1/organizations/rolesPapéis e permissões
Autenticação: Sessão do console
Projects
get/v1/projectsLista projetos
Autenticação: Sessão do console
Permissão: projects:read
post/v1/projectsCria um projeto
Autenticação: Sessão do console
Permissão: projects:write
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
}
},
"required": [
"name"
],
"additionalProperties": false
}Catalog
get/v1/productsCatálogo de produtos com estado de ativação
Autenticação: Sessão do console
Permissão: products:read
post/v1/products/{key}/activateAtiva um produto
Autenticação: Sessão do console
Permissão: products:activate
delete/v1/products/{key}/activateDesativa um produto
Autenticação: Sessão do console
Permissão: products:activate
get/v1/capabilitiesCapacidades e disponibilidade no ambiente
Autenticação: Sessão ou chave de API
post/v1/capabilities/executeExecuta uma capacidade
Autenticação: Sessão ou chave de API
Permissão: capabilities:execute
Aceita Idempotency-Key.
{
"type": "object",
"properties": {
"capabilityKey": {
"type": "string",
"maxLength": 80
},
"input": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 40
},
"additionalProperties": {}
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
}
},
"required": [
"capabilityKey",
"input"
],
"additionalProperties": false
}Business
post/v1/business/lookupConsulta um CNPJ
Autenticação: Sessão ou chave de API
Permissão: business:execute
Aceita Idempotency-Key.
{
"type": "object",
"properties": {
"cnpj": {
"type": "string",
"minLength": 11,
"maxLength": 20
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
}
},
"required": [
"cnpj"
],
"additionalProperties": false
}post/v1/business/verifyVerificação completa de empresa
Autenticação: Sessão ou chave de API
Permissão: business:execute
Aceita Idempotency-Key.
{
"type": "object",
"properties": {
"cnpj": {
"type": "string",
"minLength": 11,
"maxLength": 20
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
},
"legalBasis": {
"default": "legitimate_interest",
"type": "string",
"enum": [
"consent",
"legal_obligation",
"contract",
"legitimate_interest",
"fraud_prevention",
"credit_protection"
]
}
},
"required": [
"cnpj",
"purpose"
],
"additionalProperties": false
}Compliance
post/v1/compliance/screenTriagem corporativa
Autenticação: Sessão ou chave de API
Permissão: compliance:execute
Aceita Idempotency-Key.
{
"type": "object",
"properties": {
"cnpj": {
"type": "string",
"minLength": 11,
"maxLength": 20
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
}
},
"required": [
"cnpj"
],
"additionalProperties": false
}Identity
post/v1/identity/sessionsCria sessão hospedada de identidade
Autenticação: Sessão ou chave de API
Permissão: identity:execute
{
"type": "object",
"properties": {
"workflowVersionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"processingPurpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
},
"legalBasis": {
"type": "string",
"enum": [
"consent",
"legal_obligation",
"contract",
"legitimate_interest",
"fraud_prevention",
"credit_protection"
]
},
"subjectRef": {
"type": "string",
"maxLength": 120
},
"redirectUrl": {
"type": "string",
"maxLength": 2000
},
"allowedOrigins": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
"ttlMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440
}
},
"required": [
"workflowVersionId",
"processingPurpose",
"legalBasis"
],
"additionalProperties": false
}Workflows
get/v1/workflowsLista workflows
Autenticação: Sessão ou chave de API
Permissão: workflows:read
post/v1/workflowsCria um workflow
Autenticação: Sessão do console
Permissão: workflows:write
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"description": {
"type": "string",
"maxLength": 500
},
"template": {
"default": "blank",
"type": "string",
"enum": [
"blank",
"business_verification",
"person_selfie",
"person_document_selfie",
"person_full"
]
}
},
"required": [
"name"
],
"additionalProperties": false
}get/v1/workflows/{id}Detalhe do workflow
Autenticação: Sessão ou chave de API
Permissão: workflows:read
patch/v1/workflows/{id}Atualiza o rascunho
Autenticação: Sessão do console
Permissão: workflows:write
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"description": {
"type": "string",
"maxLength": 500
},
"draftGraph": {}
},
"additionalProperties": false
}post/v1/workflows/validateValida um grafo e estima custo
Autenticação: Sessão do console
Permissão: workflows:read
post/v1/workflows/{id}/publishPublica uma versão imutável
Autenticação: Sessão do console
Permissão: workflows:publish
get/v1/workflows/{id}/appearanceAparência do fluxo hospedado
Autenticação: Sessão do console
Permissão: workflows:read
put/v1/workflows/{id}/appearanceAltera a aparência do fluxo hospedado
Autenticação: Sessão do console
Permissão: workflows:write
post/v1/workflows/{id}/logoEnvia a logo do fluxo (PNG, JPEG ou WebP)
Autenticação: Sessão do console
Permissão: workflows:write
delete/v1/workflows/{id}/logoRemove a logo do fluxo
Autenticação: Sessão do console
Permissão: workflows:write
Executions
post/v1/executionsInicia uma execução
Autenticação: Sessão ou chave de API
Permissão: workflows:execute
{
"type": "object",
"properties": {
"workflowVersionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"input": {
"type": "object",
"propertyNames": {
"type": "string",
"maxLength": 40
},
"additionalProperties": {
"anyOf": [
{
"type": "string",
"maxLength": 500
},
{
"type": "number"
},
{
"type": "boolean"
}
]
}
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
},
"legalBasis": {
"default": "legitimate_interest",
"type": "string",
"enum": [
"consent",
"legal_obligation",
"contract",
"legitimate_interest",
"fraud_prevention",
"credit_protection"
]
},
"costLimitMinor": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"workflowVersionId",
"input",
"purpose"
],
"additionalProperties": false
}get/v1/executionsLista execuções
Autenticação: Sessão ou chave de API
Permissão: workflows:read
get/v1/executions/{id}Detalhe da execução
Autenticação: Sessão ou chave de API
Permissão: workflows:read
post/v1/executions/{id}/cancelCancela uma execução
Autenticação: Sessão ou chave de API
Permissão: workflows:execute
Sessions
post/v1/sessionsCria uma sessão hospedada
Autenticação: Sessão ou chave de API
Permissão: sessions:write
{
"type": "object",
"properties": {
"workflowVersionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"processingPurpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
},
"legalBasis": {
"type": "string",
"enum": [
"consent",
"legal_obligation",
"contract",
"legitimate_interest",
"fraud_prevention",
"credit_protection"
]
},
"subjectRef": {
"type": "string",
"maxLength": 120
},
"redirectUrl": {
"type": "string",
"maxLength": 2000
},
"allowedOrigins": {
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"maxLength": 300
}
},
"ttlMinutes": {
"type": "integer",
"minimum": 5,
"maximum": 1440
}
},
"required": [
"workflowVersionId",
"processingPurpose",
"legalBasis"
],
"additionalProperties": false
}get/v1/sessionsLista sessões
Autenticação: Sessão ou chave de API
Permissão: sessions:read
get/v1/sessions/{id}Detalhe, resultados e linha do tempo
Autenticação: Sessão ou chave de API
Permissão: sessions:read
post/v1/sessions/{id}/linkEmite novo link hospedado
Autenticação: Sessão ou chave de API
Permissão: sessions:write
post/v1/sessions/{id}/cancelCancela a sessão
Autenticação: Sessão ou chave de API
Permissão: sessions:write
post/v1/sessions/{id}/reportGera relatório em PDF
Autenticação: Sessão ou chave de API
Permissão: reports:write
get/v1/reportsLista relatórios gerados
Autenticação: Sessão ou chave de API
Permissão: reports:read
post/v1/evidence/{id}/download-linkLink curto de download de evidência
Autenticação: Sessão do console
Permissão: sessions:read_sensitive
get/v1/evidence/download/{token}Baixa evidência com link curto
Autenticação: Público
Hosted
post/v1/hosted/exchangeTroca o token do link por uma credencial de sessão
Autenticação: Público
{
"type": "object",
"properties": {
"token": {
"type": "string",
"minLength": 10,
"maxLength": 300
}
},
"required": [
"token"
],
"additionalProperties": false
}get/v1/hosted/stateProgresso da sessão
Autenticação: Sessão hospedada
get/v1/hosted/logoLogo do fluxo da sessão
Autenticação: Sessão hospedada
post/v1/hosted/steps/{key}Envia uma etapa
Autenticação: Sessão hospedada
post/v1/hosted/uploads/{step}Envia uma captura
Autenticação: Sessão hospedada
post/v1/hosted/handoffGera um código de uso único para continuar em outro aparelho
Autenticação: Sessão hospedada
post/v1/hosted/handoff/cancelDesconecta os outros aparelhos e códigos pendentes
Autenticação: Sessão hospedada
Cases
get/v1/casesLista casos de revisão
Autenticação: Sessão do console
Permissão: cases:read
get/v1/cases/{id}Detalhe do caso
Autenticação: Sessão do console
Permissão: cases:read
post/v1/cases/{id}/decisionRegistra uma decisão
Autenticação: Sessão do console
Permissão: cases:decide
{
"type": "object",
"properties": {
"decision": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED"
]
},
"note": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"decision"
],
"additionalProperties": false
}Monitoring
get/v1/monitoringLista monitoramentos
Autenticação: Sessão ou chave de API
Permissão: monitoring:read
post/v1/monitoringCria um monitoramento
Autenticação: Sessão ou chave de API
Permissão: monitoring:write
{
"type": "object",
"properties": {
"cnpj": {
"type": "string",
"minLength": 11,
"maxLength": 20
},
"purpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
},
"intervalHours": {
"default": 168,
"type": "integer",
"minimum": 24,
"maximum": 720
}
},
"required": [
"cnpj",
"purpose"
],
"additionalProperties": false
}delete/v1/monitoring/{id}Encerra um monitoramento
Autenticação: Sessão ou chave de API
Permissão: monitoring:write
get/v1/monitoring/alertsLista alertas
Autenticação: Sessão ou chave de API
Permissão: monitoring:read
post/v1/monitoring/alerts/{id}/ackReconhece um alerta
Autenticação: Sessão do console
Permissão: monitoring:write
Developers
get/v1/api-keysLista chaves de API
Autenticação: Sessão do console
Permissão: api_keys:read
post/v1/api-keysCria uma chave de API
Autenticação: Sessão do console
Permissão: api_keys:write
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"scopes": {
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "string",
"maxLength": 40
}
},
"expiresInDays": {
"type": "integer",
"minimum": 1,
"maximum": 730
}
},
"required": [
"name",
"scopes"
],
"additionalProperties": false
}delete/v1/api-keys/{id}Revoga uma chave de API
Autenticação: Sessão do console
Permissão: api_keys:write
get/v1/webhooksLista endpoints de webhook
Autenticação: Sessão ou chave de API
Permissão: webhooks:read
post/v1/webhooksCria um endpoint de webhook
Autenticação: Sessão ou chave de API
Permissão: webhooks:write
{
"type": "object",
"properties": {
"url": {
"type": "string",
"maxLength": 2000,
"format": "uri"
},
"events": {
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
}
},
"required": [
"url",
"events"
],
"additionalProperties": false
}patch/v1/webhooks/{id}Atualiza um endpoint
Autenticação: Sessão ou chave de API
Permissão: webhooks:write
{
"type": "object",
"properties": {
"active": {
"type": "boolean"
},
"events": {
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
}
},
"additionalProperties": false
}delete/v1/webhooks/{id}Remove um endpoint
Autenticação: Sessão ou chave de API
Permissão: webhooks:write
get/v1/webhooks/deliveriesHistórico de entregas
Autenticação: Sessão ou chave de API
Permissão: webhooks:read
post/v1/webhooks/{id}/testEnvia um evento de teste
Autenticação: Sessão do console
Permissão: webhooks:write
MCP
get/v1/mcp/toolsCatálogo de ferramentas MCP
Autenticação: Sessão do console
Permissão: mcp:read
get/v1/mcp/connectionsLista conexões
Autenticação: Sessão do console
Permissão: mcp:read
post/v1/mcp/connectionsCria uma conexão
Autenticação: Sessão do console
Permissão: mcp:write
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"processingPurpose": {
"type": "string",
"minLength": 5,
"maxLength": 300
},
"spendLimitMinor": {
"type": "integer",
"minimum": 0,
"maximum": 100000000
},
"ratePerMinute": {
"default": 60,
"type": "integer",
"minimum": 1,
"maximum": 600
},
"tools": {
"minItems": 1,
"maxItems": 30,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 60
},
"requiresApproval": {
"default": false,
"type": "boolean"
}
},
"required": [
"name"
]
}
}
},
"required": [
"name",
"processingPurpose",
"spendLimitMinor",
"tools"
],
"additionalProperties": false
}patch/v1/mcp/connections/{id}Atualiza ou revoga uma conexão
Autenticação: Sessão do console
Permissão: mcp:write
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"ACTIVE",
"PAUSED",
"REVOKED"
]
},
"spendLimitMinor": {
"type": "integer",
"minimum": 0,
"maximum": 100000000
},
"ratePerMinute": {
"type": "integer",
"minimum": 1,
"maximum": 600
}
},
"additionalProperties": false
}get/v1/mcp/approvalsFila de aprovações
Autenticação: Sessão do console
Permissão: mcp:read
post/v1/mcp/approvals/{id}Decide uma aprovação
Autenticação: Sessão do console
Permissão: mcp:approve
{
"type": "object",
"properties": {
"decision": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED"
]
}
},
"required": [
"decision"
],
"additionalProperties": false
}post/v1/mcp/playground/previewPré-visualiza a autorização de uma chamada
Autenticação: Sessão do console
Permissão: mcp:execute
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"tool": {
"type": "string",
"maxLength": 60
},
"args": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"connectionId",
"tool"
],
"additionalProperties": false
}post/v1/mcp/playground/executeExecuta uma ferramenta pelo playground
Autenticação: Sessão do console
Permissão: mcp:execute
{
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"tool": {
"type": "string",
"maxLength": 60
},
"args": {
"default": {},
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"connectionId",
"tool"
],
"additionalProperties": false
}post/v1/mcp/oauth/consentConcede acesso a um cliente MCP
Autenticação: Sessão do console
Permissão: mcp:write
{
"type": "object",
"properties": {
"clientId": {
"type": "string",
"maxLength": 100
},
"redirectUri": {
"type": "string",
"maxLength": 2000
},
"codeChallenge": {
"type": "string",
"maxLength": 200
},
"codeChallengeMethod": {
"type": "string",
"maxLength": 10
},
"resource": {
"type": "string",
"maxLength": 500
},
"scope": {
"type": "string",
"maxLength": 500
},
"state": {
"type": "string",
"maxLength": 500
},
"connectionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"clientId",
"redirectUri",
"codeChallenge",
"codeChallengeMethod",
"resource",
"scope",
"connectionId"
],
"additionalProperties": false
}post/v1/mcp/oauth/denyRecusa o acesso de um cliente MCP
Autenticação: Sessão do console
{
"type": "object",
"properties": {
"clientId": {
"type": "string",
"maxLength": 100
},
"redirectUri": {
"type": "string",
"maxLength": 2000
},
"state": {
"type": "string",
"maxLength": 500
}
},
"required": [
"clientId",
"redirectUri"
],
"additionalProperties": false
}Usage
get/v1/usage/summaryResumo de consumo
Autenticação: Sessão ou chave de API
Permissão: usage:read
get/v1/usage/eventsEventos de consumo
Autenticação: Sessão ou chave de API
Permissão: usage:read
get/v1/usage/dashboardMétricas do painel
Autenticação: Sessão do console
Permissão: usage:read
Billing
get/v1/billing/walletSaldo da carteira
Autenticação: Sessão do console
Permissão: billing:read
patch/v1/billing/walletLimites de orçamento
Autenticação: Sessão do console
Permissão: billing:write
{
"type": "object",
"properties": {
"budgetLimitMinor": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"lowBalanceMinor": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
}get/v1/billing/ledgerExtrato imutável
Autenticação: Sessão do console
Permissão: billing:read
get/v1/billing/paymentsPagamentos
Autenticação: Sessão do console
Permissão: billing:read
post/v1/billing/top-upInicia compra de créditos via Pix
Autenticação: Sessão do console
Permissão: billing:write
Aceita Idempotency-Key.
{
"type": "object",
"properties": {
"amountMinor": {
"type": "integer",
"minimum": 1000,
"maximum": 100000000
}
},
"required": [
"amountMinor"
],
"additionalProperties": false
}post/v1/billing/payments/{id}/simulate-confirmationConfirma pagamento simulado (somente sandbox)
Autenticação: Sessão do console
Permissão: billing:write
get/v1/billing/invoicesFaturas
Autenticação: Sessão do console
Permissão: billing:read
post/v1/billing/webhooks/{gateway}Webhook do gateway de pagamento
Autenticação: Público
Security
get/v1/security/overviewEstado real de segurança
Autenticação: Sessão do console
Permissão: security:read
get/v1/security/policyPolítica de segurança
Autenticação: Sessão do console
Permissão: security:read
patch/v1/security/policyAtualiza a política
Autenticação: Sessão do console
Permissão: security:write
{
"type": "object",
"properties": {
"requireMfa": {
"type": "boolean"
},
"sessionMaxHours": {
"type": "integer",
"minimum": 1,
"maximum": 720
},
"ipAllowlist": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"maxLength": 60
}
},
"mcpRequireApproval": {
"type": "boolean"
}
},
"additionalProperties": false
}get/v1/security/eventsEventos de segurança
Autenticação: Sessão do console
Permissão: security:read
get/v1/security/credentialsInventário de credenciais
Autenticação: Sessão do console
Permissão: security:read
get/v1/audit/eventsEventos de auditoria
Autenticação: Sessão do console
Permissão: audit:read
Privacy
get/v1/privacy/overviewRetenção e suboperadores
Autenticação: Sessão do console
Permissão: privacy:read
post/v1/privacy/retentionDefine retenção por categoria
Autenticação: Sessão do console
Permissão: privacy:write
{
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"document",
"biometric",
"report"
]
},
"retentionDays": {
"type": "integer",
"minimum": 1,
"maximum": 3650
}
},
"required": [
"category",
"retentionDays"
],
"additionalProperties": false
}get/v1/privacy/requestsRequisições de titulares
Autenticação: Sessão do console
Permissão: privacy:read
post/v1/privacy/requestsRegistra requisição de titular
Autenticação: Sessão do console
Permissão: privacy:write
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"access",
"export",
"deletion",
"correction"
]
},
"subjectRef": {
"type": "string",
"minLength": 3,
"maxLength": 120
},
"note": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"type",
"subjectRef"
],
"additionalProperties": false
}patch/v1/privacy/requests/{id}Atualiza requisição
Autenticação: Sessão do console
Permissão: privacy:write
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"IN_PROGRESS",
"COMPLETED",
"REJECTED"
]
},
"note": {
"type": "string",
"maxLength": 1000
}
},
"required": [
"status"
],
"additionalProperties": false
}Public
post/v1/public/leadsFormulário de contato comercial
Autenticação: Público
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 120
},
"email": {
"type": "string",
"maxLength": 254,
"format": "email",
"pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
},
"company": {
"type": "string",
"maxLength": 160
},
"message": {
"type": "string",
"maxLength": 2000
},
"source": {
"default": "contact",
"type": "string",
"maxLength": 40
},
"consent": {
"type": "boolean",
"const": true
}
},
"required": [
"name",
"email",
"consent"
],
"additionalProperties": false
}