Skip to main content
1

Obter sua API key

Gere um token Bearer no dashboard Mycroft. Consulte a pagina de autenticacao para instrucoes detalhadas.
Os tokens usam o formato myc_xxxxxxxxxxxxx.
2

Enviar arquivo CNAB para analise

Envie um arquivo CNAB 400 (.rem) para criar uma nova operacao de analise:
curl -X POST https://api-mycroft.sherlocker.com.br/api/v1/operations \
  -H "Authorization: Bearer myc_sua_chave_aqui" \
  -F "file=@bordero.rem" \
  -F "cedenteCnpj=11222333000181"
Para maior precisao nas regras de NFe, envie um arquivo ZIP com os XMLs das notas fiscais junto com o CNAB.
curl -X POST https://api-mycroft.sherlocker.com.br/api/v1/operations \
  -H "Authorization: Bearer myc_sua_chave_aqui" \
  -F "file=@bordero.rem" \
  -F "cedenteCnpj=11222333000181" \
  -F "xmls=@notas.zip"
Resposta esperada (202 Accepted):
{
  "operationId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "createdAt": "2026-03-08T12:00:00.000Z"
}
3

Acompanhar status (polling)

Consulte o status da operacao ate que esteja concluida:
curl -X GET https://api-mycroft.sherlocker.com.br/api/v1/operations/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer myc_sua_chave_aqui"
Repita a cada 2-5 segundos ate que status seja "completed" ou "failed". Resposta quando concluido:
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "createdAt": "2026-03-08T12:00:00.000Z",
  "completedAt": "2026-03-08T12:00:12.000Z",
  "tituloCount": 45,
  "approvedCount": 34,
  "blockedCount": 8,
  "alertCount": 3
}
O processamento tipicamente leva entre 5 e 30 segundos dependendo do tamanho do arquivo.
4

Obter resultado da analise

Com a operacao concluida, obtenha o resultado hierarquico completo:
curl -X GET https://api-mycroft.sherlocker.com.br/api/v1/operations/550e8400-e29b-41d4-a716-446655440000/result \
  -H "Authorization: Bearer myc_sua_chave_aqui"
O resultado segue uma hierarquia cedente -> sacado -> titulo, onde cada titulo inclui as regras aplicadas:
{
  "operationId": "550e8400-e29b-41d4-a716-446655440000",
  "cedente": {
    "cnpj": "11222333000181",
    "razaoSocial": "Comercial ABC Ltda",
    "sacados": [
      {
        "cnpjCpf": "44555666000199",
        "razaoSocial": "Industria XYZ S/A",
        "titulos": [
          {
            "numero": "DUP-2026-001",
            "valor": 15000.00,
            "dataVencimento": "2026-04-15",
            "status": "blocked",
            "issues": [
              {
                "ruleId": "R3",
                "ruleName": "Titulo vencido",
                "category": "blocking",
                "status": "blocked",
                "message": "Titulo com data de vencimento expirada ha mais de 30 dias",
                "detail": {
                  "field": "dataVencimento",
                  "actual": "2026-01-01",
                  "expected": ">= 2026-03-08",
                  "threshold": 30
                },
                "dataSource": "XML NFe"
              }
            ]
          }
        ]
      }
    ]
  }
}
Consulte a API Reference para detalhes completos do schema de resposta.

​
Proximos passos

Autenticacao

Detalhes sobre geracao e rotacao de tokens

API Reference

Documentacao completa de todos os endpoints