Alias:
SERVICE_PGFN_COMPANY · Preço: R$ 0,90 por consultaPOST /v1/services. Você pode combinar este serviço com outros na mesma chamada, enviando cada identificador uma vez.
Campos do request
| Campo | Obrigatório | Descrição |
|---|---|---|
services | sim | Inclua "SERVICE_PGFN_COMPANY" na lista. |
cnpj | sim | CNPJ, com ou sem pontuação. |
Campos em result
| Campo | Descrição | Tipo |
|---|---|---|
cnpj | CNPJ | number |
pgfn_summary | Resumo da Certidão PGFN | text |
pgfn_base_status | Situação da Certidão PGFN | text |
pgfn_clearance | Sem Pendências na PGFN | text |
pgfn_emission_date | Data de Emissão da Certidão PGFN | text |
pgfn_certificate_url | Link da Certidão PGFN | text |
result traz também outcome, o resumo da consulta: clear, alert, match, no_match ou not_found.
curl --request POST 'https://api.omni-ward.com/v1/services' \
--header 'Authorization: Bearer $OMNI_WARD_API_KEY' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: $(uuidgen)' \
--data '{
"services": [
"SERVICE_PGFN_COMPANY"
],
"cnpj": "00000000000000"
}'
const res = await fetch('https://api.omni-ward.com/v1/services', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.OMNI_WARD_API_KEY}`,
'Content-Type': 'application/json',
'Idempotency-Key': crypto.randomUUID(),
},
body: JSON.stringify({
"services": [
"SERVICE_PGFN_COMPANY"
],
"cnpj": "00000000000000"
}),
});
const { results } = await res.json();
import os, uuid, requests
res = requests.post(
"https://api.omni-ward.com/v1/services",
headers={"Authorization": f"Bearer {os.environ['OMNI_WARD_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={
"services": [
"SERVICE_PGFN_COMPANY"
],
"cnpj": "00000000000000"
},
timeout=90,
)
results = res.json()["results"]
$ch = curl_init("https://api.omni-ward.com/v1/services");
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer " . getenv("OMNI_WARD_API_KEY"),
"Content-Type: application/json",
"Idempotency-Key: " . bin2hex(random_bytes(16)),
],
CURLOPT_POSTFIELDS => '{"services":["SERVICE_PGFN_COMPANY"],"cnpj":"00000000000000"}',
]);
$results = json_decode(curl_exec($ch), true)["results"];
var body = """
{
"services": [
"SERVICE_PGFN_COMPANY"
],
"cnpj": "00000000000000"
}
""";
var request = HttpRequest.newBuilder(URI.create("https://api.omni-ward.com/v1/services"))
.header("Authorization", "Bearer " + System.getenv("OMNI_WARD_API_KEY"))
.header("Content-Type", "application/json")
.header("Idempotency-Key", UUID.randomUUID().toString())
.POST(HttpRequest.BodyPublishers.ofString(body))
.build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
{
"results": [
{
"service": "SERVICE_PGFN_COMPANY",
"status": {
"code": 200,
"message": "Success"
},
"result": {
"cnpj": 0,
"pgfn_summary": "texto",
"pgfn_base_status": "texto",
"pgfn_clearance": "texto",
"pgfn_emission_date": "texto",
"pgfn_certificate_url": "texto",
"outcome": "clear"
},
"simulated": false,
"costMinor": 90
}
],
"totalCostMinor": 90
}
{
"error": {
"code": "validation_failed",
"message": "Alguns serviços não podem ser executados. Nada foi consultado nem cobrado.",
"correlationId": "4f1c9a7e-2b1d-4c55-9a51-0d2f6f1c2a10",
"details": {
"results": [
{
"service": "SERVICE_PGFN_COMPANY",
"status": {
"code": 422,
"message": "Validation failed"
},
"result": null,
"errors": [
{
"field": "cnpj",
"code": "required",
"message": "Informe CNPJ: este serviço exige o campo."
}
]
}
]
}
}
}