Alias:
SERVICE_DEBT_COLLECTION_PERSON · Preço: R$ 0,70 por consulta · Exige purposePOST /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_DEBT_COLLECTION_PERSON" na lista. |
cpf | sim | CPF, com ou sem pontuação. |
purpose | sim | Finalidade do tratamento. Este serviço trata dados pessoais. |
birthDate | não | Data de nascimento, no formato AAAA-MM-DD. |
Campos em result
| Campo | Descrição | Tipo |
|---|---|---|
Collections | Objeto principal de retorno do dataset, contendo as informações consolidadas relacionadas à pessoa consultada. | object |
Collections.IsCurrentlyOnCollection | Flag indicando se a pessoa está atualmente em algum processo de cobrança. | boolean |
Collections.TotalCollectionOccurrences | Número de ocorrências de cobrança identificadas para a pessoa em todo o histórico. | integer |
Collections.TotalCollectionOrigins | Número de origens (processos distintos) de cobrança identificados para a pessoa em todo o histórico. | integer |
Collections.Last30DaysCollectionOccurrences | Número de ocorrências de cobrança identificadas para a pessoa nos últimos 30 dias. | integer |
Collections.Last90DaysCollectionOccurrences | Número de ocorrências de cobrança identificadas para a pessoa nos últimos 90 dias. | integer |
Collections.Last180DaysCollectionOccurrences | Número de ocorrências de cobrança identificadas para a pessoa nos últimos 180 dias. | integer |
Collections.Last365DaysCollectionOccurrences | Número de ocorrências de cobrança identificadas para a pessoa nos últimos 365 dias. | integer |
Collections.Last30DaysCollectionOrigins | Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 30 dias. | integer |
Collections.Last90DaysCollectionOrigins | Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 90 dias. | integer |
Collections.Last180DaysCollectionOrigins | Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 180 dias. | integer |
Collections.Last365DaysCollectionOrigins | Número de origens (processos distintos) de cobrança identificados para a pessoa nos últimos 365 dias. | integer |
Collections.TotalCollectionMonths | Número total de meses em que a pessoa esteve em pelo menos um processo de cobrança. | integer |
Collections.CurrentConsecutiveCollectionMonths | Número de meses consecutivos (incluindo o atual) no qual a pessoa está em cobrança. | integer |
Collections.MaxConsecutiveCollectionMonths | Número máximo de meses consecutivos em que a pessoa esteve (ou está) em cobrança. | integer |
Collections.FirstCollectionDate | Data da primeira cobrança registrada para a entidade. | string |
Collections.LastCollectionDate | Data da última cobrança registrada para a entidade. | string |
Collections.CreationDate | Data de criação do registro. | string |
Collections.LastUpdateDate | Data da última atualização do registro. | string |
Collections.CollectionOccurrences | Mesmo que TotalCollectionOccurences: sendo mantido na solução por motivos de compatibilidade com versões anteriores, para não quebrar as integrações com a API de empresas. | integer |
Collections.CollectionOrigins | Mesmo que TotalCollectionOrigins: sendo mantido na solução por motivos de compatibilidade com versões anteriores, para não quebrar as integrações com a API de empresas. | integer |
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_DEBT_COLLECTION_PERSON"
],
"cpf": "00000000000",
"purpose": "Abertura de conta"
}'
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_DEBT_COLLECTION_PERSON"
],
"cpf": "00000000000",
"purpose": "Abertura de conta"
}),
});
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_DEBT_COLLECTION_PERSON"
],
"cpf": "00000000000",
"purpose": "Abertura de conta"
},
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_DEBT_COLLECTION_PERSON"],"cpf":"00000000000","purpose":"Abertura de conta"}',
]);
$results = json_decode(curl_exec($ch), true)["results"];
var body = """
{
"services": [
"SERVICE_DEBT_COLLECTION_PERSON"
],
"cpf": "00000000000",
"purpose": "Abertura de conta"
}
""";
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_DEBT_COLLECTION_PERSON",
"status": {
"code": 200,
"message": "Success"
},
"result": {
"Collections": {
"IsCurrentlyOnCollection": false,
"Last30DaysCollectionOccurrences": 0,
"Last90DaysCollectionOccurrences": 0,
"Last180DaysCollectionOccurrences": 0,
"Last365DaysCollectionOccurrences": 0,
"Last30DaysCollectionOrigins": 0,
"Last90DaysCollectionOrigins": 0,
"Last180DaysCollectionOrigins": 0,
"Last365DaysCollectionOrigins": 0,
"TotalCollectionMonths": 3,
"CurrentConsecutiveCollectionMonths": 0,
"MaxConsecutiveCollectionMonths": 0,
"FirstCollectionDate": "2017-05-03T20:19:21Z",
"LastCollectionDate": "2017-10-11T20:18:22Z",
"CollectionOccurrences": 7,
"CollectionOrigins": 3
},
"outcome": "clear"
},
"simulated": false,
"costMinor": 70
}
],
"totalCostMinor": 70
}
{
"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_DEBT_COLLECTION_PERSON",
"status": {
"code": 422,
"message": "Validation failed"
},
"result": null,
"errors": [
{
"field": "cpf",
"code": "required",
"message": "Informe CPF: este serviço exige o campo."
}
]
}
]
}
}
}
