> ## Documentation Index > Fetch the complete documentation index at: https://docs.sherlocker.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Consultar análise > Retorna o estado atual e o resultado de uma análise. Enquanto pending/running, a resposta inclui poll_after_seconds no body e o header Retry-After com o mesmo valor: aguarde esse intervalo antes do próximo poll. Quando completed/failed, traz verdict, blocks e coverage. ## OpenAPI ````yaml /openapi/motor-analise.json get /analyses/{id} openapi: 3.0.0 info: title: Sherlocker Motor de Análise - API v1 description: >- API pública do Motor de Análise: cria análises de risco assíncronas de CNPJ (PJ) e CPF (PF) e consulta o resultado por polling. Autenticação por chave de API (Bearer slhk_) no header. Erros em RFC 7807 (application/problem+json). Em beta: requer as features analysis_engine (e analysis_engine_pf para CPF) habilitadas no workspace. version: '1.0' servers: - url: https://221b-api.sherlocker.com.br/api/v1 description: >- Mesma base da API 221b. Autentica via Authorization: Bearer slhk_ (nao usa ?token=). security: - bearerAuth: [] paths: /analyses/{id}: get: tags: - Análises summary: Consultar análise description: >- Retorna o estado atual e o resultado de uma análise. Enquanto pending/running, a resposta inclui poll_after_seconds no body e o header Retry-After com o mesmo valor: aguarde esse intervalo antes do próximo poll. Quando completed/failed, traz verdict, blocks e coverage. operationId: getAnalysis parameters: - name: id in: path required: true schema: type: string format: uuid description: UUID da análise (campo id da resposta do POST). - name: x-request-id in: header required: false schema: type: string description: >- Identificador de rastreio opcional fornecido pelo cliente. Gerado pelo servidor se omitido; ecoado no header da resposta. responses: '200': description: >- Estado atual da análise. Header Retry-After presente apenas em estados não-terminais (pending/running). headers: Retry-After: schema: type: integer description: >- Segundos a aguardar antes do próximo poll. Presente apenas quando status é pending ou running. x-request-id: schema: type: string description: Identificador da requisição (ecoado ou gerado). content: application/json: schema: $ref: '#/components/schemas/Analysis' examples: running: summary: Em processamento value: id: a1b2c3d4-0000-0000-0000-000000000001 status: running subject_type: pj document: '12345678000195' verdict: null blocks: null coverage: null created_at: '2026-06-30T10:00:00Z' finished_at: null poll_after_seconds: 2 request_id: 3166fb9a-384c-44b7-ab77-90aca3146e0a completed: summary: Concluída value: id: a1b2c3d4-0000-0000-0000-000000000001 status: completed subject_type: pj document: '12345678000195' verdict: aprovado blocks: - id: SITUACAO_CADASTRAL_CNPJ status: pass detail: CNPJ ativo na Receita Federal. evidence: [] - id: SANCAO_NACIONAL status: pass detail: Não encontrado em listas de sanções nacionais. evidence: [] coverage: - source: company status: fetched fetched_at: '2026-06-30T10:00:00Z' - source: serasa status: fetched fetched_at: '2026-06-30T10:00:05Z' created_at: '2026-06-30T10:00:00Z' finished_at: '2026-06-30T10:00:30Z' request_id: 3166fb9a-384c-44b7-ab77-90aca3146e0a '401': description: Chave de API ausente, malformada, inválida ou revogada. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' '404': description: Análise inexistente ou pertencente a outro workspace. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: type: https://docs.sherlocker.com.br/problems/not_found title: Not Found status: 404 code: not_found detail: Analysis run not found instance: /v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a components: schemas: Analysis: type: object required: - id - status - subject_type - document - created_at properties: id: type: string format: uuid description: UUID da análise. status: type: string enum: - pending - running - completed - failed description: Estado do ciclo de vida da análise. subject_type: type: string enum: - pj - pf description: Tipo do analisado. document: type: string description: Documento (CNPJ/CPF) analisado, apenas dígitos. verdict: type: string enum: - aprovado - alerta - reprovado - incompleto nullable: true description: >- Veredito final de risco; null enquanto pending/running. incompleto = algum bloco ficou unavailable (ver coverage). blocks: type: array nullable: true items: $ref: '#/components/schemas/AnalysisBlock' description: Resultados individuais dos blocos; null até a análise terminar. coverage: type: array nullable: true items: $ref: '#/components/schemas/AnalysisCoverage' description: >- Relatório de cobertura das fontes de dados; null até a análise terminar. tokens_charged: type: number description: Tokens debitados por esta análise. balance: type: number description: Saldo de tokens do workspace após o débito. created_at: type: string format: date-time description: Timestamp ISO 8601 de criação. finished_at: type: string format: date-time nullable: true description: >- Timestamp ISO 8601 de término (completed ou failed); null enquanto em andamento. poll_after_seconds: type: number description: >- Segundos a aguardar antes do próximo poll. Presente apenas em estados não-terminais (pending/running). request_id: type: string description: Identificador da requisição para rastreio e suporte. Problem: type: object required: - type - title - status - code description: >- Erro no formato RFC 7807 (application/problem+json). Use o campo code para tratamento programático; type é apenas identificador. properties: type: type: string description: >- URI que identifica o tipo do problema (https://docs.sherlocker.com.br/problems/). title: type: string description: Resumo curto do tipo do problema. status: type: integer description: Status HTTP desta ocorrência. code: type: string description: >- Código estável para tratamento programático (ex.: insufficient_tokens). detail: type: string description: Explicação legível específica desta ocorrência. instance: type: string description: Identificador da ocorrência (/v1?request_id=). errors: type: array description: >- Erros de validação por campo. Presente apenas em validation_error (400). items: type: object properties: field: type: string message: type: string required: type: number description: Tokens necessários. Presente apenas em insufficient_tokens (402). balance: type: number description: Saldo atual de tokens. Presente apenas em insufficient_tokens (402). request_access_url: type: string description: Onde solicitar acesso. Presente apenas em feature_not_enabled (403). AnalysisBlock: type: object properties: id: type: string description: 'Identificador do bloco (ex.: SITUACAO_CADASTRAL_CNPJ).' status: type: string enum: - pass - alert - blocked - unavailable description: Resultado do bloco. detail: type: string description: Resumo legível do achado do bloco. evidence: type: array items: $ref: '#/components/schemas/AnalysisEvidence' description: Evidências de suporte, quando disponíveis. AnalysisCoverage: type: object properties: source: type: string description: Identificador da fonte de dados consultada. status: type: string enum: - fetched - cached - failed description: Resultado da busca na fonte. fetched_at: type: string format: date-time nullable: true description: Timestamp ISO 8601 de quando o dado foi obtido, se conhecido. AnalysisEvidence: type: object properties: field: type: string description: Campo avaliado pela regra. value: type: string description: Valor encontrado na fonte de dados. expected: type: string description: Valor esperado pela regra do bloco. result: type: string description: 'Resultado da comparação (ex.: match, divergent).' securitySchemes: bearerAuth: type: http scheme: bearer description: >- Chave de API do workspace (prefixo slhk_), enviada no header: Authorization: Bearer slhk_sua_chave_aqui ````