Executar serviços

Executa um ou mais serviços de consulta com os mesmos identificadores. Todos os serviços são validados antes de qualquer consulta; se algum não puder rodar, a resposta é 422 e nada é cobrado. Depois, os serviços rodam ao mesmo tempo e a resposta traz um item por alias, na ordem pedida.

POST /v1/services

cURL

varios

curl --request POST \ --url https://api.omni-ward.com/v1/services \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "services": [ "SERVICE_CORPORATE_DATA_ENRICHMENT", "SERVICE_RFB_PF", "SERVICE_EMAIL_VALIDATION" ] } '

200

{
  "results": [
    {
      "service": "SERVICE_RFB_PJ",
      "status": {
        "code": 200,
        "message": "Success"
      },
      "result": {
        "company_name": "texto",
        "company_fantasy_name": "texto",
        "state_foundation_company": "texto",
        "nire": 0,
        "capital": "texto",
        "capital_rs": "texto",
        "activities": "texto",
        "founded_date": "2020-01-01",
        "legal_nature_code": "texto",
        "legal_nature_activity": "texto",
        "regime": "texto",
        "status": "texto",
        "status_date": "2020-01-01",
        "outcome": "clear"
      },
      "simulated": false,
      "costMinor": 50
    }
  ],
  "totalCostMinor": 50
}

Authorizations

Authorization · string · header · required

Chave de API criada no console: ow_test_… (sandbox) ou ow_live_… (produção).

Headers

Idempotency-Key · string

Maximum string length: 128

Body

application/json

services · enum<string>[] · required

Aliases dos serviços, de 1 a 20, sem repetir. Veja o catálogo de serviços.

Required array length: 1 - 20 elements

Available options: SERVICE_ACTIVE_DEBT_PF, SERVICE_ACTIVE_DEBT_PJ, SERVICE_ADDRESS, SERVICE_ARREST_WARRANT, SERVICE_CIVIL_CONSTRUCTION, SERVICE_COMPANY_EVOLUTION, SERVICE_COMPANY_KYC_OWNERS, SERVICE_COMPANY_RELATIONSHIP, SERVICE_COMPANY_RFB_OWNERS, SERVICE_COMPLIANCE_BET_PJ, SERVICE_CONFIRM_PHONE, SERVICE_CORPORATE_DATA_ENRICHMENT, SERVICE_CORPORATE_TIES_PERSON, SERVICE_CPF_ADDRESS_VALIDATION, SERVICE_CPF_NAME_CHECK, SERVICE_CPF_PHONE_VALIDATION, SERVICE_CPF_QUERY_HISTORY, SERVICE_CREDIT_RISK_COMPANY, SERVICE_CREDIT_RISK_SIGNALS_PERSON, SERVICE_CREDIT_SCORE, SERVICE_CREDIT_SCORE_ALT_COMPANY, SERVICE_CREDIT_SCORE_ALT_PERSON, SERVICE_CRIMINAL_RECORD_FEDERAL, SERVICE_CUSTOM_SCORE_COMPANY, SERVICE_DAS_MEI, SERVICE_DEMOGRAPHIC_DATA_CPF, SERVICE_DOMAINS_CNPJ, SERVICE_DOMAINS_CPF, SERVICE_ECONOMIC_GROUP_KYC_COMPANY, SERVICE_ECONOMIC_RELATIONSHIP, SERVICE_EMAILS_EXTENDED, SERVICE_EMAIL_VALIDATION, SERVICE_EMPLOYEES_KYC, SERVICE_FACE_INDEX, SERVICE_FACE_MATCH_CPF, SERVICE_FGTS, SERVICE_FINANCIAL_INFORMATION, SERVICE_FIRST_LEVEL_PARTNER, SERVICE_FRAUD_RISK_SCORE, SERVICE_HISTORY_BASIC_DATA, SERVICE_JURIDICAL_PROCESSES, SERVICE_JURIDICAL_PROCESSES_PJ, SERVICE_JURIDICAL_PROCESSES_PJ_OWNERS, SERVICE_LABOR_LAWSUITS, SERVICE_LAWSUITS_DISTRIBUTION_DATA_COMPANY, SERVICE_MARKETPLACE_DATA, SERVICE_MEDIA_PROFILE_EXPOSURE_PF, SERVICE_MEDIA_PROFILE_EXPOSURE_PJ, SERVICE_MEI, SERVICE_MERCHANT_CATEGORY_DATA, SERVICE_ONDEMAND_SUS_CARD_PERSON_CPF, SERVICE_ONE_SCORE_COMPANY, SERVICE_ONE_SCORE_PERSON, SERVICE_ONLINE_ADS, SERVICE_OWNERS_LAWSUITS_DISTRIBUTION, SERVICE_OWNER_PARTICIPATION_DATA_COMPANY, SERVICE_PCD_COMPANY, SERVICE_PERSON_DATA_ENRICHMENT, SERVICE_PERSON_KYC, SERVICE_PF_FINANCIAL_AND_ADDRESS, SERVICE_PGFN_COMPANY, SERVICE_PGMEI, SERVICE_PHONES_EXTENDED_COMPANY, SERVICE_PHONE_HISTORY, SERVICE_PROFESSIONAL_HISTORY, SERVICE_PUBLIC_PROJECTS, SERVICE_PUBLIC_SERVANTS, SERVICE_REGISTRATION_DATA_CNPJ, SERVICE_RELATED_PEOPLE, SERVICE_RFB_PF, SERVICE_RFB_PJ, SERVICE_RF_QSA, SERVICE_SIMPLES_COMPANY, SERVICE_SOCIAL_ASSISTANCE_EXTENDED, SERVICE_SYNDICATE_AGREEMENTS, SERVICE_ULTIMATE_BENEFICIAL_OWNERS, SEVICE_ONLINE_BETTING_PROPENSITY

Required string length: 1 - 80

Example:

["SERVICE_RFB_PJ"]

cpf · string

CPF, com ou sem pontuação. Obrigatório nos serviços que o usam.

Maximum string length: 20

Example:

"00000000000"

cnpj · string

CNPJ, com ou sem pontuação. Obrigatório nos serviços que o usam.

Maximum string length: 20

Example:

"00000000000000"

phone · string

Telefone com DDD, só dígitos. Obrigatório nos serviços que o usam.

Maximum string length: 20

Example:

"11999999999"

email · string

Endereço de e-mail. Obrigatório nos serviços que o usam.

Maximum string length: 254

Example:

"[e-mail]"

face · string

Foto do rosto em base64, com ou sem o prefixo data:image/...;base64,. Obrigatório nos serviços que o usam.

Maximum string length: 6000000

Example:

"/9j/4AAQSkZJRgABAQ…"

name · string

Nome completo. Obrigatório nos serviços que o usam.

Maximum string length: 120

Example:

"NOME DA PESSOA"

birthDate · string

Data de nascimento, no formato AAAA-MM-DD. Obrigatório nos serviços que o usam.

Maximum string length: 10

Example:

"1990-01-31"

motherName · string

Nome completo da mãe. Obrigatório nos serviços que o usam.

Maximum string length: 120

Example:

"NOME DA MÃE"

fatherName · string

Nome completo do pai. Obrigatório nos serviços que o usam.

Maximum string length: 120

Example:

"NOME DO PAI"

zipcode · string

CEP, 8 dígitos. Obrigatório nos serviços que o usam.

Maximum string length: 9

Example:

"01001000"

numberAddress · string

Número do endereço. Obrigatório nos serviços que o usam.

Maximum string length: 10

Example:

"100"

purpose · string

Finalidade do tratamento. Obrigatória quando algum serviço trata dados pessoais, biométricos ou restritivos.

Required string length: 5 - 300

Example:

"Abertura de conta"

Response

200

application/json

Requisição processada. Confira o status de cada item: um serviço pode falhar sem afetar os outros.

results · object[] · required

Show child attributes

totalCostMinor · integer · required

Total cobrado, em centavos.