Criar análise

POST

analyses

curl --request POST \
  --url https://221b-api.sherlocker.com.br/api/v1/analyses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "document": "12345678000195",
  "subject_type": "pj",
  "purpose": "due diligence de fornecedor"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "tokens_charged": 123,
  "balance": 123,
  "poll_after_seconds": 123,
  "request_id": "<string>"
}

{
  "id": "a1b2c3d4-0000-0000-0000-000000000001",
  "status": "pending",
  "tokens_charged": 10,
  "balance": 990,
  "poll_after_seconds": 2,
  "request_id": "3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/bad_request",
  "title": "Bad Request",
  "status": 400,
  "code": "bad_request",
  "detail": "Idempotency-Key header required",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Authentication is required to access this resource.",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/insufficient_tokens",
  "title": "Payment Required",
  "status": 402,
  "code": "insufficient_tokens",
  "detail": "Insufficient tokens: 5 available, 10 required",
  "required": 10,
  "balance": 5,
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/feature_not_enabled",
  "title": "Feature Not Enabled",
  "status": 403,
  "code": "feature_not_enabled",
  "detail": "The analysis_engine feature is not enabled for this workspace. To request access visit https://docs.sherlocker.com.br/api/access or contact support at https://docs.sherlocker.com.br/support.",
  "request_access_url": "https://docs.sherlocker.com.br/api/access",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/idempotency_conflict",
  "title": "Conflict",
  "status": 409,
  "code": "idempotency_conflict",
  "detail": "A request with the same idempotency key is already in progress or completed.",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/no_engine",
  "title": "Unprocessable Entity",
  "status": 422,
  "code": "no_engine",
  "detail": "No analysis engine is configured or the engine cannot process this request.",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

Authorizations

Authorization

string

header

required

Chave de API do workspace (prefixo slhk_), enviada no header: Authorization: Bearer slhk_sua_chave_aqui

Headers

Idempotency-Key

string

required

Chave única por requisição lógica (UUID recomendado). Obrigatória. Reenviar a mesma chave com o mesmo body em até 24h devolve a resposta original (HTTP 200) sem nova cobrança; mesma chave com body diferente devolve 409.

x-request-id

string

Identificador de rastreio opcional fornecido pelo cliente. Gerado pelo servidor se omitido; ecoado no header da resposta.

Body

application/json

document

string

required

CNPJ (14 dígitos) ou CPF (11 dígitos) do analisado, com ou sem máscara.

Example:

"12345678000195"

subject_type

enum<string>

Tipo do analisado. Auto-detectado pelo tamanho do documento (14 → pj, 11 → pf). Se enviado, precisa ser compatível com o documento.

Available options:

pj,

pf

engine_id

string<uuid>

UUID da engine de análise a usar. Omitido: usa a engine padrão do workspace ou o template do sistema (PJ/PF).

purpose

string

Finalidade da análise (texto livre). Opcional; gravada no log de auditoria PF em análises de CPF.

legal_basis

enum<string>

Base legal LGPD para tratamento de dados pessoais. Opcional; gravada no log de auditoria PF em análises de CPF.

Available options:

consentimento,

legitimo_interesse,

cumprimento_obrigacao_legal,

protecao_credito

Response

Replay idempotente: mesma Idempotency-Key + mesmo body dentro da janela de 24h. Corpo idêntico ao da resposta 202 original; nenhum token adicional é cobrado.

string<uuid>

required

UUID da análise criada. Use no GET /analyses/{id}.

status

enum<string>

required

Sempre pending imediatamente após a criação.

Available options:

pending

tokens_charged

number

Tokens debitados do saldo do workspace na criação.

balance

number

Saldo de tokens do workspace após o débito.

poll_after_seconds

number

Sugestão de espera (segundos) antes do primeiro poll.

request_id

string

Identificador da requisição para rastreio e suporte. Igual ao header x-request-id da resposta.

⌘I

curl --request POST \
  --url https://221b-api.sherlocker.com.br/api/v1/analyses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "document": "12345678000195",
  "subject_type": "pj",
  "purpose": "due diligence de fornecedor"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "tokens_charged": 123,
  "balance": 123,
  "poll_after_seconds": 123,
  "request_id": "<string>"
}

{
  "id": "a1b2c3d4-0000-0000-0000-000000000001",
  "status": "pending",
  "tokens_charged": 10,
  "balance": 990,
  "poll_after_seconds": 2,
  "request_id": "3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/bad_request",
  "title": "Bad Request",
  "status": 400,
  "code": "bad_request",
  "detail": "Idempotency-Key header required",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Authentication is required to access this resource.",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/insufficient_tokens",
  "title": "Payment Required",
  "status": 402,
  "code": "insufficient_tokens",
  "detail": "Insufficient tokens: 5 available, 10 required",
  "required": 10,
  "balance": 5,
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/feature_not_enabled",
  "title": "Feature Not Enabled",
  "status": 403,
  "code": "feature_not_enabled",
  "detail": "The analysis_engine feature is not enabled for this workspace. To request access visit https://docs.sherlocker.com.br/api/access or contact support at https://docs.sherlocker.com.br/support.",
  "request_access_url": "https://docs.sherlocker.com.br/api/access",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/idempotency_conflict",
  "title": "Conflict",
  "status": 409,
  "code": "idempotency_conflict",
  "detail": "A request with the same idempotency key is already in progress or completed.",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

{
  "type": "https://docs.sherlocker.com.br/problems/no_engine",
  "title": "Unprocessable Entity",
  "status": 422,
  "code": "no_engine",
  "detail": "No analysis engine is configured or the engine cannot process this request.",
  "instance": "/v1?request_id=3166fb9a-384c-44b7-ab77-90aca3146e0a"
}

Começando

Conceitos

Motor de CPF/CNPJ

Motor de Borderô (títulos & NFe)

Referência comum

Acesso e suporte

Authorizations

Headers

Body

Response