Pular para o conteúdo
CotejarCotejarCotejar para desenvolvedores

Solicitar análise completa da empresa

POST
/v1/analises
curl --request POST \
  --url https://api.cotejar.com.br/v1/analises \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: pedido-exemplo-00000001' \
  --data '{}'

Exige analise:executar e Idempotency-Key. Envie {}. O aceite durável não consome franquia. Produtos selecionados para vigilância não restringem o diagnóstico.

Autorizações

Seção intitulada “Autorizações”

Parâmetros

Seção intitulada “Parâmetros”

Parâmetros de cabeçalho

Seção intitulada “Parâmetros de cabeçalho”
idempotency-key
obrigatório

Gere uma chave por pedido e preserve-a somente nas repetições desse mesmo pedido.

string
>= 16 caracteres <= 128 caracteres /^[A-Za-z0-9._:-]+$/
Exemplo
pedido-exemplo-00000001

Corpo da requisiçãoobrigatório

Seção intitulada “Corpo da requisiçãoobrigatório”
Tipo de mídiaapplication/json
object
0
Exemplogerado
{}

Respostas

Seção intitulada “Respostas”

200

Seção intitulada “200”

Response for status 200

Tipo de mídiaapplication/json
object
id
obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

string
/^[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}$/
estado
obrigatório
string
Valores permitidos: pendente executando concluida falhou
Exemplo
{
  "id": "0198d000-0000-7000-8000-000000000001",
  "estado": "pendente"
}

Cabeçalhos

Seção intitulada “Cabeçalhos”
Location
string

Caminho da consulta do recurso criado ou da operação aceita. Aceite não comprova conclusão.

202

Seção intitulada “202”

Response for status 202

Tipo de mídiaapplication/json
object
id
obrigatório

Exemplo sintético; substitua pelo UUID obtido na consulta do seu recurso.

string
/^[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}$/
estado
obrigatório
string
Valores permitidos: pendente executando concluida falhou
Exemplo
{
  "id": "0198d000-0000-7000-8000-000000000001",
  "estado": "pendente"
}

Cabeçalhos

Seção intitulada “Cabeçalhos”
Location
string

Caminho da consulta do recurso criado ou da operação aceita. Aceite não comprova conclusão.

400

Seção intitulada “400”

Response for status 400

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

401

Seção intitulada “401”

Response for status 401

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

403

Seção intitulada “403”

Response for status 403

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

404

Seção intitulada “404”

Response for status 404

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

408

Seção intitulada “408”

Response for status 408

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

409

Seção intitulada “409”

Response for status 409

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

412

Seção intitulada “412”

Response for status 412

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

413

Seção intitulada “413”

Response for status 413

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

415

Seção intitulada “415”

Response for status 415

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

422

Seção intitulada “422”

Response for status 422

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

428

Seção intitulada “428”

Response for status 428

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

429

Seção intitulada “429”

Response for status 429

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}

503

Seção intitulada “503”

Response for status 503

Tipo de mídiaapplication/json
object
erro
obrigatório
object
codigo
obrigatório
string
mensagem
obrigatório
string
request_id
obrigatório
string
caminho
string
Exemplogerado
{
  "erro": {
    "codigo": "example",
    "mensagem": "example",
    "request_id": "example",
    "caminho": "example"
  }
}