Services de pessoa física

Request e response de cada consulta de pessoa física.

Ainda não disponível. Estas páginas descrevem o contrato previsto para /api/token-generate e /api/service-api, que ainda não respondem no servidor. A API ativa hoje é a REST v1.

68 de 68 services

Antecedentes criminais civisSERVICE_CRIMINAL_RECORD_CIVIL

POST/api/service-api

Campos do request

service
cpf
rg
uf

Campos em result: cpf, rg, state, hasRecords, records.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_CIVIL",
  "cpf": "cpf",
  "rg": "rg",
  "uf": "uf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "rg": "rg",
    "state": "SP",
    "hasRecords": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Antecedentes criminais federaisSERVICE_CRIMINAL_RECORD_FEDERAL

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, hasFederalCriminalRecord, records.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CRIMINAL_RECORD_FEDERAL",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "hasFederalCriminalRecord": false,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Benefícios sociais estendidosSERVICE_SOCIAL_ASSISTANCE_EXTENDED

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalBenefits, benefits, indicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_SOCIAL_ASSISTANCE_EXTENDED",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ],
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Benefícios sociais familiaresSERVICE_FAMILY_SOCIAL_BENEFITS

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalBenefits, benefits.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_SOCIAL_BENEFITS",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalBenefits": 1,
    "benefits": [
      {
        "program": "Programa social",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Busca de face na baseSERVICE_FACE_INDEX

POST/api/service-api

Campos do request

service
selfie

Campos em result: cpf.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_INDEX",
  "selfie": "base64"
}'

Response

{
  "result": {
    "cpf": "cpf"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

CPF na Receita Federal on-demandSERVICE_RFB_PF_ON_DEMAND

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, name, birthDate, status, protocol.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF_ON_DEMAND",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "status": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Cartão SUSSERVICE_ONDEMAND_SUS_CARD_PERSON_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, sus_card_success, sus_card_number, sus_card_source, sus_card_capture_date, sus_card_birth_date, sus_card_birth_city, sus_card_birth_state, sus_card_has_evidence, sus_card_raw_result_file, sus_card_raw_result_file_type, sus_card_summary.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "sus_card_success": "Sim",
    "sus_card_number": "126000000000009",
    "sus_card_source": "BA",
    "sus_card_capture_date": "08/25/2025 20:07:36",
    "sus_card_birth_date": "03/13/1980 00:00:00",
    "sus_card_birth_city": "CHORROCHO",
    "sus_card_birth_state": "BA",
    "sus_card_has_evidence": "Não",
    "sus_card_raw_result_file": "https://example.com/documents/sus-card.pdf",
    "sus_card_raw_result_file_type": "pdf",
    "sus_card_summary": "Cartão SUS localizado"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Certidão de Nada ConstaSERVICE_NOTHING_RECORD_LAWSUITS

POST/api/service-api

Campos do request

service
cpf
court
uf
sphere

Campos em result: cpf, court, sphere, nothingFound, records.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_NOTHING_RECORD_LAWSUITS",
  "cpf": "cpf",
  "court": "TRF1",
  "uf": "uf",
  "sphere": "CIVIL"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "court": "TRF1",
    "sphere": "CIVIL",
    "nothingFound": true,
    "records": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Certidão negativa de protestoSERVICE_PROTEST_CLEARANCE_CERTIFICATE

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, hasProtests, protests.

Veja também: SERVICE_PROTEST_PF

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_CLEARANCE_CERTIFICATE",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Certidão negativa de protesto PFSERVICE_PROTEST_PF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, hasProtests, notaryOffices, protests.

Veja também: SERVICE_PROTEST_CLEARANCE_CERTIFICATE

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROTEST_PF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "hasProtests": false,
    "notaryOffices": [],
    "protests": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Consulta de MEISERVICE_MEI

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, meiCompanies.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEI",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "meiCompanies": [
      {
        "cnpj": "cnpj",
        "officialName": "MEI EXEMPLO",
        "status": "ATIVA"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dados PISSERVICE_PIS_CONSULTATION

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, pis, status.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PIS_CONSULTATION",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "pis": "00000000000",
    "status": "FOUND"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dados RestritivosSERVICE_BUREAU_CREDIT_SCORE_PERSON

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, score, hasRestrictions, restrictionCount, creditBureauSummary, creditBureauDetails, origin, queryDate.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_BUREAU_CREDIT_SCORE_PERSON",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "score": 705,
    "hasRestrictions": false,
    "restrictionCount": 0,
    "creditBureauSummary": "Nenhuma restrição de crédito encontrada",
    "creditBureauDetails": {},
    "origin": "Fonte de dados",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dados demográficosSERVICE_DEMOGRAPHIC_DATA_CPF

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, demographicData, totalIndicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEMOGRAPHIC_DATA_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "demographicData": [
      {
        "indicator": "Faixa de renda",
        "value": "Media"
      }
    ],
    "totalIndicators": 1
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dados eleitorais de candidatoSERVICE_ELECTION_CANDIDATE_DATA_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, candidacies.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTION_CANDIDATE_DATA_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "candidacies": [
      {
        "year": 2024,
        "role": "VEREADOR",
        "party": "PARTIDO",
        "status": "DEFERIDO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dados financeiros e endereçosSERVICE_PF_FINANCIAL_AND_ADDRESS

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, estimatedIncome, addresses, financialIndicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PF_FINANCIAL_AND_ADDRESS",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "addresses": [
      {
        "city": "Sao Paulo",
        "state": "SP"
      }
    ],
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dados pelo telefoneSERVICE_CONFIRM_PHONE

POST/api/service-api

Campos do request

service
phone

Campos em result: phone, matched, person.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CONFIRM_PHONE",
  "phone": "+5561123456789"
}'

Response

{
  "result": {
    "phone": "+5561123456789",
    "matched": true,
    "person": {
      "name": "Nome encontrado",
      "document": "cpf"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Doações eleitoraisSERVICE_ELECTORAL_DONORS_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, donations.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTORAL_DONORS_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "donations": [
      {
        "year": 2024,
        "recipient": "Candidato",
        "amount": "500.00"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Documentoscopia digitalSERVICE_DIGITAL_DOCUMENTOSCOPY

POST/api/service-api

Campos do request

service
key
image1
image2
selfie1

Campos em result: key, status, documentData, validations.

Veja também: SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY",
  "key": "84bfcd2e-2336-4e30-bcab-15348b7890b5",
  "image1": "base64",
  "image2": "base64",
  "selfie1": "base64"
}'

Response

{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "documentData": {
      "name": "Nome extraído",
      "cpf": "cpf"
    },
    "validations": [
      {
        "name": "faceMatch",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

DomíniosSERVICE_DOMAINS_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalDomains, domains.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DOMAINS_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalDomains": 1,
    "domains": [
      {
        "domain": "exemplo.com.br",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Dívida ativaSERVICE_ACTIVE_DEBT_PF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalDebts, totalValue, debts.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVE_DEBT_PF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalDebts": 2,
    "totalValue": "1234.56",
    "debts": [
      {
        "source": "PGFN",
        "value": "1234.56",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

E-mails de Pessoas RelacionadasSERVICE_RELATED_PEOPLE_EMAILS

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalRelatedPeopleEmails, relatedPeopleEmailsList, relatedPeopleEmails.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_EMAILS",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeopleEmails": 2,
    "relatedPeopleEmailsList": "[email protected] - NOME DA PESSOA - 00000000000 - CONJUGE",
    "relatedPeopleEmails": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "CONJUGE",
        "type": "PESSOAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "email": "[email protected]",
        "domain": "email.com",
        "validationStatus": "VALID"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

EndereçosSERVICE_ADDRESS

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalAddresses, addresses.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ADDRESS",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalAddresses": 2,
    "addresses": [
      {
        "address": "Rua Exemplo",
        "number": "100",
        "neighborhood": "Centro",
        "city": "Sao Paulo",
        "state": "SP",
        "zipcode": "01001000"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Endereços de Pessoas RelacionadasSERVICE_RELATED_PEOPLE_ADDRESSES

POST/api/service-api

Campos do request

service
cnpj

Campos em result: cnpj, totalRelatedPeopleAddresses, relatedPeopleAddressesList, relatedPeopleAddresses.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_ADDRESSES",
  "cnpj": "cnpj"
}'

Response

{
  "result": {
    "cnpj": "cnpj",
    "totalRelatedPeopleAddresses": 1,
    "relatedPeopleAddressesList": "RUA EXEMPLO, 100 - NOME DA PESSOA - 00000000000 - SOCIO",
    "relatedPeopleAddresses": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "SOCIO",
        "type": "RESIDENCIAL",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "address": "RUA EXEMPLO",
        "zipcode": "00000000",
        "state": "SP",
        "city": "SAO PAULO",
        "neighborhood": "CENTRO",
        "number": "100",
        "complement": "",
        "isRatified": true
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Enriquecimento de dadosSERVICE_PERSON_DATA_ENRICHMENT

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, name, birthDate, status, motherName.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_ENRICHMENT",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "status": "REGULAR",
    "motherName": "Nome da mãe"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Envolvimento políticoSERVICE_POLITICAL_INVOLVEMENT

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, politicalInvolvement.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "CANDIDACY",
        "year": 2024,
        "details": "Candidatura encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Envolvimento político PFSERVICE_POLITICAL_INVOLVEMENT_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, politicalInvolvement.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_POLITICAL_INVOLVEMENT_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "politicalInvolvement": [
      {
        "type": "DONATION",
        "year": 2024,
        "details": "Doacao encontrada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Exposição e perfil na mídiaSERVICE_MEDIA_PROFILE_EXPOSURE_PF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, mediaMentions, exposureLevel.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_MEDIA_PROFILE_EXPOSURE_PF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "mediaMentions": [
      {
        "title": "Noticia encontrada",
        "source": "Fonte",
        "sentiment": "NEUTRAL"
      }
    ],
    "exposureLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

FaceMatchSERVICE_FACE_MATCH

POST/api/service-api

Campos do request

service
selfie
image2

Campos em result: match, similarity, status.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_MATCH",
  "selfie": "base64",
  "image2": "base64"
}'

Response

{
  "result": {
    "match": true,
    "similarity": 98.2,
    "status": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Flags NegativosSERVICE_CREDIT_RISK_SIGNALS_PERSON

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, riskLevel, riskClassification, hasRestrictions, negativeFlagsCount, creditBureauSummary, creditBureauDetails, origin, queryDate.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CREDIT_RISK_SIGNALS_PERSON",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "hasRestrictions": false,
    "negativeFlagsCount": 0,
    "creditBureauSummary": "Nenhum flag negativo encontrado",
    "creditBureauDetails": {},
    "origin": "Fonte de dados",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Histórico de e-mailsSERVICE_EMAILS_EXTENDED

POST/api/service-api

Campos do request

service
cpf
limit

Campos em result: cpf, emails.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAILS_EXTENDED",
  "cpf": "cpf",
  "limit": "10"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "emails": [
      {
        "email": "[email protected]",
        "priority": 1,
        "isValid": true,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Histórico de telefonesSERVICE_PHONE_HISTORY

POST/api/service-api

Campos do request

service
cpf
limit
birthDate (opcional)

Campos em result: cpf, phones.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PHONE_HISTORY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "limit": "10"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "phones": [
      {
        "phone": "11900000000",
        "lineType": "MOBILE",
        "priority": 1,
        "lastUpdate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Histórico familiar políticoSERVICE_FAMILY_POLITICAL_HISTORY_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, familyPoliticalHistory.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FAMILY_POLITICAL_HISTORY_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "familyPoliticalHistory": [
      {
        "relativeName": "Nome relacionado",
        "relationship": "PARENTE",
        "role": "Candidato"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Histórico profissionalSERVICE_PROFESSIONAL_HISTORY

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, professionalHistory.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "professionalHistory": [
      {
        "companyName": "Empresa Exemplo",
        "role": "Analista",
        "startDate": "yyyy-MM-dd"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Histórico profissional do titularSERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, ownerHistory.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PROFESSIONAL_HISTORY_OWNER_ONLY",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "ownerHistory": [
      {
        "companyName": "Empresa Exemplo",
        "cnpj": "cnpj",
        "qualification": "SOCIO"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Indicadores de atividadesSERVICE_ACTIVITIES_INDICATORS

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, activityIndicators, hasActivityIndicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ACTIVITIES_INDICATORS",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "activityIndicators": [
      {
        "type": "PROFESSIONAL",
        "description": "Indicador encontrado"
      }
    ],
    "hasActivityIndicators": true
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Informações financeirasSERVICE_FINANCIAL_INFORMATION

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, estimatedIncome, purchasingPower, financialIndicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_INFORMATION",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "estimatedIncome": "5000-10000",
    "purchasingPower": "MEDIUM",
    "financialIndicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

KYC e complianceSERVICE_PERSON_KYC

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, isPep, sanctions, mediaExposure, riskAlerts.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_KYC",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "sanctions": [],
    "mediaExposure": [],
    "riskAlerts": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Mandado de prisãoSERVICE_ARREST_WARRANT

POST/api/service-api

Campos do request

service
nome
motherName
fatherName
birthDate
cpf

Campos em result: cpf, hasArrestWarrant, warrants.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ARREST_WARRANT",
  "nome": "nome",
  "motherName": "nome da mãe",
  "fatherName": "nome do pai",
  "birthDate": "dd/MM/yyyy",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "hasArrestWarrant": false,
    "warrants": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Modelagem de dadosSERVICE_PERSON_DATA_MODELING

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, profileSummary, contacts, addresses, relationships.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_DATA_MODELING",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "profileSummary": "Resumo consolidado",
    "contacts": [],
    "addresses": [],
    "relationships": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

OCR ReactSERVICE_OCR

POST/api/service-api

Campos do request

service
documentType
selfie
image2 (opcional)

Campos em result: cpf, docType, name, birthDate, cnhCategory, cnhNumber.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR",
  "documentType": "IDENTIFICATION_DOCUMENT",
  "selfie": "base64",
  "image2": "base64 (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "docType": "CNH",
    "name": "Nome extraído",
    "birthDate": "yyyy-MM-dd",
    "cnhCategory": "B",
    "cnhNumber": "00000000000"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

OCR de comprovante de endereçoSERVICE_OCR_PROOF_OF_ADDRESS

POST/api/service-api

Campos do request

service
image1

Campos em result: genericOcr, fullName, fullAddress, docType, dueDate, invoiceAmount.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_PROOF_OF_ADDRESS",
  "image1": "base64"
}'

Response

{
  "result": {
    "genericOcr": "texto extraído",
    "fullName": "Nome extraído",
    "fullAddress": "Endereço extraído",
    "docType": "Conta de consumo",
    "dueDate": "yyyy-MM-dd",
    "invoiceAmount": "R$ 100,00"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

OCR de emancipaçãoSERVICE_OCR_EMANCIPATION

POST/api/service-api

Campos do request

service
image1

Campos em result: docType, genericOcr, extractedFields, analysis.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_OCR_EMANCIPATION",
  "image1": "base64"
}'

Response

{
  "result": {
    "docType": "EMANCIPATION_DOCUMENT",
    "genericOcr": "texto extraído",
    "extractedFields": {
      "cpf": "cpf",
      "dates": [
        "yyyy-MM-dd"
      ]
    },
    "analysis": {
      "isEmancipationRelated": true,
      "confidence": "MEDIUM"
    }
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Pessoa politicamente expostaSERVICE_PEP

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, isPep, positions.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PEP",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "isPep": false,
    "positions": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Pessoas relacionadasSERVICE_RELATED_PEOPLE

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, relatedPeople.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "relatedPeople": [
      {
        "name": "Pessoa relacionada",
        "relationshipType": "FAMILIAR",
        "confidence": "HIGH"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Prestadores de serviço eleitoraisSERVICE_ELECTORAL_PROVIDERS_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, campos.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ELECTORAL_PROVIDERS_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "campos": [
      {
        "year": 2024,
        "campaign": "Campanha",
        "amount": "800.00",
        "serviceType": "Servico"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Processos jurídicos e administrativosSERVICE_JURIDICAL_PROCESSES

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalProcesses, processes.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_JURIDICAL_PROCESSES",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalProcesses": 1,
    "processes": [
      {
        "court": "TJSP",
        "processNumber": "0000000-00.0000.0.00.0000",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Prompt de IA para pessoaSERVICE_PERSON_AI_PROMPT

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, answer, highlights.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PERSON_AI_PROMPT",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "answer": "Resumo analitico gerado pela IA",
    "highlights": [
      "ponto relevante"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Propensão a apostas onlineSEVICE_ONLINE_BETTING_PROPENSITY

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, propensityScore, propensityLevel, indicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SEVICE_ONLINE_BETTING_PROPENSITY",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "propensityScore": 78,
    "propensityLevel": "HIGH",
    "indicators": [
      "sinal encontrado"
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Prêmios e certificaçõesSERVICE_AWARDS_AND_CERTIFICATIONS_CPF

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalAwards, totalCertifications, awards, certifications.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_AWARDS_AND_CERTIFICATIONS_CPF",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalAwards": 0,
    "totalCertifications": 0,
    "awards": [],
    "certifications": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Relacionamentos econômicosSERVICE_ECONOMIC_RELATIONSHIP

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, relationships.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ECONOMIC_RELATIONSHIP",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "relationships": [
      {
        "type": "OWNER",
        "relatedDocument": "cnpj",
        "relatedName": "Empresa relacionada"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Resultado da documentoscopia digitalSERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT

POST/api/service-api

Campos do request

service
key

Campos em result: key, status, fields, rules.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DIGITAL_DOCUMENTOSCOPY_CONSULT",
  "key": "de0cd562-5962-40bd-8f94-5a7184ecde0e"
}'

Response

{
  "result": {
    "key": "{key}",
    "status": "APPROVED",
    "fields": [
      {
        "name": "cpf",
        "value": "cpf"
      }
    ],
    "rules": [
      {
        "name": "document",
        "status": "APPROVED"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Risco financeiroSERVICE_FINANCIAL_RISK_SCORE

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, score, riskLevel, recommendation.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FINANCIAL_RISK_SCORE",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "score": 681,
    "riskLevel": "MEDIUM",
    "recommendation": "REVIEW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Score biométricoSERVICE_FACE_CNH_VALIDATION

POST/api/service-api

Campos do request

service
cpf
image1

Campos em result: cpf, biometricScore, validated, validationStatus.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_CNH_VALIDATION",
  "cpf": "cpf",
  "image1": "{base64Image}"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "biometricScore": 0.98,
    "validated": true,
    "validationStatus": "APPROVED"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Score de CréditoSERVICE_CREDIT_SCORE_ALT_PERSON

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, score, riskLevel, riskClassification, reasonCodes, creditBureauSummary, creditBureauDetails, origin, queryDate.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CREDIT_SCORE_ALT_PERSON",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "score": 680,
    "riskLevel": "MEDIO",
    "riskClassification": "B",
    "reasonCodes": [
      "Tempo de relacionamento com o mercado",
      "Renda declarada baixa"
    ],
    "creditBureauSummary": "Score de crédito dentro da média do perfil",
    "creditBureauDetails": {},
    "origin": "Fonte de dados",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Score de Crédito MultidadosSERVICE_ONE_SCORE_PERSON

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, score, riskLevel, riskClassification, reasonCodes, creditBureauSummary, creditBureauDetails, origin, queryDate.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONE_SCORE_PERSON",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "score": 710,
    "riskLevel": "BAIXO",
    "riskClassification": "A",
    "reasonCodes": [
      "Bom histórico de pagamentos"
    ],
    "creditBureauSummary": "Score de crédito multidados acima da média do perfil",
    "creditBureauDetails": {},
    "origin": "Fonte de dados",
    "queryDate": "2026-08-01"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Score de créditoSERVICE_CREDIT_SCORE

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, score, riskLevel, message.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CREDIT_SCORE",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "score": 750,
    "riskLevel": "LOW",
    "message": "Score calculado com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Score de inadimplênciaSERVICE_DEFAULT_RISK_SCORE

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, score, riskLevel, defaultProbability.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_DEFAULT_RISK_SCORE",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "score": 690,
    "riskLevel": "MEDIUM",
    "defaultProbability": "8%"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Score de risco de fraudeSERVICE_FRAUD_RISK_SCORE

POST/api/service-api

Campos do request

service
cpf
factor

Campos em result: cpf, factor, score, riskLevel, indicators.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FRAUD_RISK_SCORE",
  "cpf": "cpf",
  "factor": "minRisk or minattrition"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "factor": "minRisk",
    "score": 720,
    "riskLevel": "LOW",
    "indicators": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Servidores públicosSERVICE_PUBLIC_SERVANTS

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, publicServantRecords.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_PUBLIC_SERVANTS",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "publicServantRecords": [
      {
        "agency": "Orgao publico",
        "role": "Cargo",
        "status": "ACTIVE"
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Status do CPF na Receita FederalSERVICE_RFB_PF

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)

Campos em result: cpf, name, birthDate, status, protocol.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RFB_PF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "name": "Nome completo",
    "birthDate": "yyyy-MM-dd",
    "status": "REGULAR",
    "protocol": "protocolo"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

TSE - Local de votaçãoSERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF

POST/api/service-api

Campos do request

service
cpf
birthDate (opcional)
motherName (opcional)

Campos em result: cpf, status, pollingPlace, pollingPlaceAddress, city, uf, zipcode, electoralZone, electoralSection, hasBiometrics, queryDate, source, onlineQuery.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ONDEMAND_TSE_POLLING_PLACE_PERSON_CPF",
  "cpf": "cpf",
  "birthDate": "yyyy-MM-dd (opcional)",
  "motherName": "nome da mãe (opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "status": "REGULAR",
    "pollingPlace": "ESCOLA CLASSE 01",
    "pollingPlaceAddress": "QUADRA 01, BRASILIA - DF",
    "city": "BRASILIA",
    "uf": "DF",
    "zipcode": "70000000",
    "electoralZone": "001",
    "electoralSection": "0001",
    "hasBiometrics": true,
    "queryDate": "2026-08-01",
    "source": "TSE-LOCALVOTACAO",
    "onlineQuery": "Situação, local, endereço, zona e seção retornados com sucesso"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Telefones de Pessoas RelacionadasSERVICE_RELATED_PEOPLE_PHONES

POST/api/service-api

Campos do request

service
cpf

Campos em result: cpf, totalRelatedPeoplePhones, relatedPeoplePhonesList, relatedPeoplePhones.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_RELATED_PEOPLE_PHONES",
  "cpf": "cpf"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "totalRelatedPeoplePhones": 1,
    "relatedPeoplePhonesList": "11900000000 - NOME DA PESSOA - 00000000000 - FILHO",
    "relatedPeoplePhones": [
      {
        "relatedCpf": "00000000000",
        "relatedName": "NOME DA PESSOA",
        "relationship": "FILHO",
        "type": "CELULAR",
        "isMain": true,
        "isRecent": true,
        "isActive": true,
        "areaCode": "11",
        "number": "900000000",
        "phone": "11900000000",
        "isInDoNotCallList": false
      }
    ]
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Validação de CPF com endereçoSERVICE_CPF_ADDRESS_VALIDATION

POST/api/service-api

Campos do request

service
cpf
zipcode
numberAddress

Campos em result: cpf, zipcode, match, confidence, normalizedAddress.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_ADDRESS_VALIDATION",
  "cpf": "cpf",
  "zipcode": "00000-000",
  "numberAddress": "13"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "zipcode": "01001000",
    "match": true,
    "confidence": "HIGH",
    "normalizedAddress": "Rua Exemplo, 100"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Validação de CPF com telefoneSERVICE_CPF_PHONE_VALIDATION

POST/api/service-api

Campos do request

service
cpf
phone

Campos em result: cpf, phone, match, statusMessage.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_CPF_PHONE_VALIDATION",
  "cpf": "cpf",
  "phone": "11900000000"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "phone": "11900000000",
    "match": true,
    "statusMessage": "Telefone associado ao documento"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Validação de e-mailSERVICE_EMAIL_VALIDATION

POST/api/service-api

Campos do request

service
email

Campos em result: email, validFormat, deliverable, domain, riskLevel.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_EMAIL_VALIDATION",
  "email": "[email protected]"
}'

Response

{
  "result": {
    "email": "[email protected]",
    "validFormat": true,
    "deliverable": true,
    "domain": "email.com",
    "riskLevel": "LOW"
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Validação do E-SocialSERVICE_ESOCIAL_REGISTRATION_QUALIFICATION

POST/api/service-api

Campos do request

service
cpf
nit (opcional)

Campos em result: cpf, nit, qualified, inconsistencies.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_ESOCIAL_REGISTRATION_QUALIFICATION",
  "cpf": "cpf",
  "nit": "(opcional)"
}'

Response

{
  "result": {
    "cpf": "cpf",
    "nit": "nit",
    "qualified": true,
    "inconsistencies": []
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}

Validação facial por CPFSERVICE_FACE_MATCH_CPF

POST/api/service-api

Campos do request

service
cpf
selfie

Campos em result: biometric_score, cpf, face_updated, face_indexed, face_found.

Request

curl --location 'https://api.omni-ward.com/api/service-api' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {jwt_token}' \
--data '{
  "service": "SERVICE_FACE_MATCH_CPF",
  "cpf": "cpf",
  "selfie": "base64"
}'

Response

{
  "result": {
    "biometric_score": "98.70",
    "cpf": "cpf",
    "face_updated": false,
    "face_indexed": true,
    "face_found": false
  },
  "status": {
    "code": 200,
    "message": "Success"
  },
  "externalId": "{externalId}"
}