Process Request (Unified Endpoint)

post

https://apigwws.bizapis.com/v3/documents/processRequest

Endpoint unificado para todos os serviços de extração de dados.

Este endpoint substitui todos os endpoints individuais da v2. Utilize o campo serviceName para especificar qual serviço deseja utilizar.

Serviços Disponíveis

Consulte a documentação completa de cada serviço na secção Services:

Portugal

França

Serviços França

Lista de serviceName válidos

at-aggregator, at-alert, at-divida, at-docs, at-interacoes, at-irc, at-iva-dp, at-iva-enquadramento, at-iva-sa, at-payref-imi, at-payref-irc, at-payref-irs, at-payref-iuc, at-payref-iva, at-pi, ce, cpp, cprc, debt, estado-empresa, ies, inpi-trademark-extraction, inpi-trademark-extraction-service, irs-by-code, irs-by-user-password, irs-by-user-password-details, nifName, rcbev2, responsabilidade-credito, responsabilidade-credito-details, rne, seguro-by-matricula, ss-docToPay, ss-no-debt, ss-payref-tsu, ss-situacao-atual

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Available Services

Autoridade Tributária (AT) Services

serviceName	Description	Required Fields
`at-aggregator`	AT Aggregator - Alerts, Interactions & Integrated Position	`user`, `password`
`at-divida`	AT Debt / No Debt	`user`, `password`
`at-irc`	AT Corporate Income Tax	`user`, `password`
`at-iva-sa`	AT VAT Current Situation	`user`, `password`
`at-iva-enquadramento`	AT VAT Framework	`user`, `password`
`at-iva-dp`	AT VAT Periodic Declarations	`user`, `password`

AT Payment References

serviceName	Description	Required Fields
`at-payref-imi`	AT Payment Reference - IMI	`user`, `password`
`at-payref-irc`	AT Payment Reference - IRC	`user`, `password`
`at-payref-irs`	AT Payment Reference - IRS	`user`, `password`
`at-payref-iuc`	AT Payment Reference - IUC	`user`, `password`
`at-payref-iva`	AT Payment Reference - IVA	`user`, `password`

IRS Services

serviceName	Description	Required Fields
`irs-by-code`	IRS by Access Code	`code`
`irs-by-user-password`	IRS by Credentials	`user`, `password`
`irs-by-user-password-details`	IRS Details by Credentials	`user`, `password`

Segurança Social (SS) Services

serviceName	Description	Required Fields
`ss-no-debt`	Social Security No Debt Certificate	`user`, `password`
`ss-sa`	Social Security Current Situation	`user`, `password`
`ss-doc-to-pay`	Social Security Documents to Pay	`user`, `password`
`ss-payref-tsu`	SS Payment Reference - TSU	`user`, `password`

Certificates & Property

serviceName	Description	Required Fields
`ce`	Energy Certificates	`certificateId`
`cp`	Caderneta Predial	`user`, `password`
`cpp`	Permanent Land Certificate	`code`
`cprc`	Permanent Commercial Registry Certificate	`code`

Commercial & Business

serviceName	Description	Required Fields	Region
`estado-empresa`	Company Status	`nif`	PT
`ies`	Simplified Business Information	`nif`, `year`	PT
`rcbe`	Beneficial Owner Registry	`nif`	PT
`nif-name`	Name Validation using NIF	`nif`	PT
`debt`	AT/SS Debt Status	`nif`	PT
`rne`	Registre National des Entreprises	`siret`	FR

Credit & Financial

serviceName	Description	Required Fields
`responsabilidade-credito`	Credit Responsibility	`user`, `password`
`responsabilidade-credito-details`	Credit Responsibility Details	`user`, `password`

Vehicles

serviceName	Description	Required Fields
`vehicles-by-nif`	Vehicles by NIF	`user`, `password`
`seguro-by-matricula`	Insurance by License Plate	`matricula`

Intellectual Property

serviceName	Description	Required Fields
`inpi-trademark-extraction`	INPI Trademark Extraction	`trademarkId`

Request Examples

User/Password Authentication

{
  "serviceName": "at-aggregator",
  "region": {
    "countryPortal": "PT",
    "jurisdictionCode": "PT"
  },
  "payload": {
    "serviceRequestBody": {
      "user": "123456789",
      "password": "yourPassword"
    }
  }
}

Code-Based Authentication

{
  "serviceName": "cpp",
  "region": {
    "countryPortal": "PT",
    "jurisdictionCode": "PT"
  },
  "payload": {
    "serviceRequestBody": {
      "code": "XXXX-XXXX-XXXX"
    }
  }
}

NIF-Based Request

{
  "serviceName": "nif-name",
  "region": {
    "countryPortal": "PT",
    "jurisdictionCode": "PT"
  },
  "payload": {
    "serviceRequestBody": {
      "nif": "123456789"
    }
  }
}

IES (with year parameter)

{
  "serviceName": "ies",
  "region": {
    "countryPortal": "PT",
    "jurisdictionCode": "PT"
  },
  "payload": {
    "serviceRequestBody": {
      "nif": "123456789",
      "year": "2023"
    }
  }
}

RNE (SIRET-Based Request)

{
  "serviceName": "rne",
  "region": {
    "countryPortal": "FR",
    "jurisdictionCode": "FR"
  },
  "payload": {
    "serviceRequestBody": {
      "siret": "12345678901234"
    }
  }
}

Response