Dossiê

Criar Dossiê padrão, modular ou com dados fornecidos

Geração assíncrona: retorna 202 e o ID para consulta. standard (default) mantém a investigação existente; modular consulta somente módulos selecionados; provided_data gera relatório/PDF somente com o JSON enviado. A chave exige entitlement dossies, escopo dossies:write e a conta deve ter public_api_dossies. modular, provided_data e qualquer risk_matrix também exigem public_api_dossies_custom, desligada por padrão. Use apenas em ambiente onde a versão está disponível e a conta foi liberada. A matriz retorna score de 0 a 100, low/medium/high e justificativas em risk_classification após a avaliação; ausência de dados obrigatórios ou coleta parcial retorna insufficient_data. Requisição inválida ou flag ausente é rejeitada antes de aceitar/cobrar.

POST

dossies

curl --request POST \
  --url https://221b-api.sherlocker.com.br/api/v1/dossies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "document": "52998224725",
  "kind": "basic"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "dossie",
  "status": "queued",
  "subject_type": "cpf",
  "kind": "basic",
  "current_attempt": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": 2,
    "status": "queued",
    "queued_at": "2023-11-07T05:31:56Z",
    "billing": {
      "id": "<string>",
      "status": "not_charged",
      "amount": 123,
      "unit": "tokens"
    },
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "artifacts": [
    {
      "id": "<string>",
      "type": "dossie_pdf",
      "media_type": "<string>",
      "status": "available",
      "download_url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "available_until": "2023-11-07T05:31:56Z"
    }
  ],
  "stale": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "coverage": {},
  "result": {
    "report_schema": [
      {}
    ],
    "risk_classification": {
      "matrix_id": "<string>",
      "matrix_version": "<string>",
      "status": "classified",
      "level": "low",
      "score": 50,
      "matched_rules": [
        {
          "id": "<string>",
          "score": 50,
          "description": "<string>"
        }
      ],
      "missing_fields": [
        "<string>"
      ]
    }
  },
  "failure": {},
  "poll_after_seconds": 123,
  "mode": "standard",
  "risk_classification": {
    "matrix_id": "<string>",
    "matrix_version": "<string>",
    "status": "classified",
    "level": "low",
    "score": 50,
    "matched_rules": [
      {
        "id": "<string>",
        "score": 50,
        "description": "<string>"
      }
    ],
    "missing_fields": [
      "<string>"
    ]
  }
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

{
  "type": "https://docs.sherlocker.com.br/problems/dossie_custom_not_enabled",
  "title": "Custom Dossier Not Enabled",
  "status": 403,
  "code": "dossie_custom_not_enabled",
  "detail": "Modular and provided_data dossiers are not enabled for this workspace.",
  "instance": "/api/v1/dossies",
  "request_id": "req_01JEXEMPLO",
  "retryable": false
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Maximum string length: 255

Body

application/json

Option 1
Option 2
Option 3

Três formatos mutuamente exclusivos. Até 256 KiB de JSON serializado e 20 níveis de profundidade. Campos desconhecidos são rejeitados. O modo padrão permanece compatível quando mode é omitido.

document

string

required

CPF/CNPJ válido em string, com ou sem pontuação. Opcional apenas em provided_data, sem disparar consultas nesse modo.

Minimum string length: 1

subject_type

enum<string>

Inferido e validado contra document. Deve ser omitido quando provided_data não envia document.

Available options:

cpf,

cnpj

kind

enum<string>

default:basic

Tipo e política de cobrança existentes; no modular não adiciona módulos omitidos.

Available options:

basic,

advanced

risk_matrix

object

Política determinística enviada pelo cliente; exige public_api_dossies_custom em qualquer modo. A soma é limitada a 100. Limiares exigem medium_min < high_min e IDs de regras únicos.

Show child attributes

context

string

Maximum string length: 2000

mode

enum<string>

default:standard

Available options:

standard

Response

Dossiê aceito

string<uuid>

required

object

enum<string>

required

Available options:

dossie

status

enum<string>

required

Available options:

queued,

running,

completed,

needs_review,

failed,

cancelled

subject_type

enum<string> | null

required

null para provided_data sem documento.

Available options:

cpf,

cnpj,

null

kind

enum<string>

required

Available options:

basic,

advanced

current_attempt

object

required

Show child attributes

artifacts

object[]

required

Show child attributes

stale

boolean

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

coverage

object

result

object

Show child attributes

failure

object

poll_after_seconds

integer

mode

enum<string>

Available options:

standard,

modular,

provided_data

risk_classification

object

Resultado determinístico disponível após avaliar a matriz, também incluído no relatório e em result.risk_classification. Dados obrigatórios ausentes ou coleta parcial retornam insufficient_data, com score e level null.

Show child attributes

curl --request POST \
  --url https://221b-api.sherlocker.com.br/api/v1/dossies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "document": "52998224725",
  "kind": "basic"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "dossie",
  "status": "queued",
  "subject_type": "cpf",
  "kind": "basic",
  "current_attempt": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "number": 2,
    "status": "queued",
    "queued_at": "2023-11-07T05:31:56Z",
    "billing": {
      "id": "<string>",
      "status": "not_charged",
      "amount": 123,
      "unit": "tokens"
    },
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z"
  },
  "artifacts": [
    {
      "id": "<string>",
      "type": "dossie_pdf",
      "media_type": "<string>",
      "status": "available",
      "download_url": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "available_until": "2023-11-07T05:31:56Z"
    }
  ],
  "stale": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "coverage": {},
  "result": {
    "report_schema": [
      {}
    ],
    "risk_classification": {
      "matrix_id": "<string>",
      "matrix_version": "<string>",
      "status": "classified",
      "level": "low",
      "score": 50,
      "matched_rules": [
        {
          "id": "<string>",
          "score": 50,
          "description": "<string>"
        }
      ],
      "missing_fields": [
        "<string>"
      ]
    }
  },
  "failure": {},
  "poll_after_seconds": 123,
  "mode": "standard",
  "risk_classification": {
    "matrix_id": "<string>",
    "matrix_version": "<string>",
    "status": "classified",
    "level": "low",
    "score": 50,
    "matched_rules": [
      {
        "id": "<string>",
        "score": 50,
        "description": "<string>"
      }
    ],
    "missing_fields": [
      "<string>"
    ]
  }
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

{
  "type": "https://docs.sherlocker.com.br/problems/dossie_custom_not_enabled",
  "title": "Custom Dossier Not Enabled",
  "status": 403,
  "code": "dossie_custom_not_enabled",
  "detail": "Modular and provided_data dossiers are not enabled for this workspace.",
  "instance": "/api/v1/dossies",
  "request_id": "req_01JEXEMPLO",
  "retryable": false
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

{
  "status": 123,
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "retryable": true
}

Começando

Conceitos

Dossiê

Rastro

Lente

Erros

Criar Dossiê padrão, modular ou com dados fornecidos

Authorizations

Headers

Body

Response