Buscar empresas de uma pessoa

POST 
/party/v1/companies-of

Inicia a busca de empresas das quais uma pessoa é sócia. A resposta depende do parâmetro wait:

• async (padrão): sempre 202, com o execution_id para acompanhar pelo GET /party/v1/companies-of/{execution_id};
• sync: a requisição espera até wait_timeout_s. Se a busca terminou, 200 com o resultado; se não, 202 (nunca erro por timeout), com o mesmo execution_id do modo assíncrono.

Repetir com segurança (Idempotency-Key, opcional). Com a mesma chave e o mesmo corpo, você recebe a busca já iniciada em vez de uma nova: 200 com o resultado, se ela já terminou (mesmo com wait=async), ou 202 com o mesmo execution_id, se ainda está em andamento. A mesma chave com corpo diferente retorna 422 idempotency_key_conflict.

Request

Responses

200

O resultado, no mesmo formato do GET, com status success ou failed: uma busca sync que terminou no prazo, ou a repetição de uma Idempotency-Key cuja busca já terminou (mesmo com wait=async).

202

Busca aceita e enfileirada: o modo async, uma busca sync que não terminou dentro de wait_timeout_s, ou a repetição de uma Idempotency-Key cuja busca ainda está em andamento (sem enfileirar outra). Timeout nunca vira erro.

400

Parâmetro inválido. O campo error.code diz qual:

• invalid_wait: wait deve ser async ou sync;
• invalid_wait_timeout: wait_timeout_s deve estar entre 1 e 20;
• invalid_idempotency_key: Idempotency-Key deve ter de 16 a 128 caracteres;
• invalid_party_id: party_id não é um UUID válido.

401

x-api-key ausente, desconhecida ou inválida.

403

Acesso negado. O campo error.code diz o motivo:

• forbidden: chave revogada ou desabilitada, ou sem permissão para a busca reversa;
• ip_not_allowed: a chave tem restrição por IP de origem e a requisição veio de fora da lista (origem da requisição não autorizada para esta chave de API). A resposta não informa a lista nem o IP visto.

Esta API não tem cota diária, então o 403 nunca é por limite de uso.

422

idempotency_key_conflict: a mesma Idempotency-Key já foi usada com um corpo diferente. Use outra chave para um pedido diferente. Erros de parâmetro, incluindo party_id malformado, retornam 400, e não este código.

429

backlog_exceeded: a fila de buscas do workspace está cheia, e esta não foi enfileirada. O header Retry-After informa, em segundos, quando tentar de novo. Esta API não tem cota diária, então não há 429 por limite de uso.

Response Headers

Retry-After

Segundos até a fila de buscas do workspace liberar.